spartera_api_sdk 0.4.2 → 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 +4 -4
- data/Gemfile +5 -3
- data/Gemfile.lock +69 -0
- data/README.md +324 -336
- data/config.json +10 -0
- data/docs/APIKeysApi.md +102 -286
- data/docs/Alert.md +36 -0
- data/docs/AlertsApi.md +163 -177
- data/docs/Apikey.md +36 -0
- data/docs/Asset.md +110 -0
- data/docs/AssetPriceHistoryApi.md +178 -202
- data/docs/Assetpricehistory.md +38 -0
- data/docs/AssetsApi.md +352 -418
- data/docs/CloudProvidersApi.md +233 -49
- data/docs/Cloudprovider.md +30 -0
- data/docs/CompaniesApi.md +171 -357
- data/docs/Company.md +44 -0
- data/docs/Connection.md +54 -0
- data/docs/ConnectionsApi.md +139 -249
- data/docs/Favorite.md +36 -0
- data/docs/FavoritesApi.md +183 -199
- data/docs/User.md +34 -0
- data/docs/UsersApi.md +97 -379
- data/example.rb +51 -0
- data/git_push.sh +2 -2
- data/lib/spartera_api_sdk/api/alerts_api.rb +176 -423
- data/lib/spartera_api_sdk/api/api_keys_api.rb +95 -496
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +177 -468
- data/lib/spartera_api_sdk/api/assets_api.rb +358 -806
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +199 -74
- data/lib/spartera_api_sdk/api/companies_api.rb +146 -660
- data/lib/spartera_api_sdk/api/connections_api.rb +139 -466
- data/lib/spartera_api_sdk/api/favorites_api.rb +204 -464
- data/lib/spartera_api_sdk/api/users_api.rb +95 -619
- data/lib/spartera_api_sdk/api_client.rb +4 -8
- data/lib/spartera_api_sdk/api_error.rb +2 -2
- data/lib/spartera_api_sdk/configuration.rb +12 -4
- data/lib/spartera_api_sdk/models/{alerts.rb → alert.rb} +139 -46
- data/lib/spartera_api_sdk/models/{api_keys.rb → apikey.rb} +124 -98
- data/lib/spartera_api_sdk/models/asset.rb +686 -0
- data/lib/spartera_api_sdk/models/{asset_price_history.rb → assetpricehistory.rb} +180 -44
- data/lib/spartera_api_sdk/models/{cloud_providers.rb → cloudprovider.rb} +111 -35
- data/lib/spartera_api_sdk/models/{companies.rb → company.rb} +105 -90
- data/lib/spartera_api_sdk/models/{connections.rb → connection.rb} +186 -69
- data/lib/spartera_api_sdk/models/error.rb +76 -3
- data/lib/spartera_api_sdk/models/{favorites.rb → favorite.rb} +111 -38
- data/lib/spartera_api_sdk/models/inline_object.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object1.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object2.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object3.rb +76 -3
- data/lib/spartera_api_sdk/models/{users.rb → user.rb} +108 -112
- data/lib/spartera_api_sdk/version.rb +3 -3
- data/lib/spartera_api_sdk.rb +11 -150
- data/spartera_api_sdk.gemspec +8 -19
- data/spec/api/alerts_api_spec.rb +51 -51
- data/spec/api/api_keys_api_spec.rb +30 -67
- data/spec/api/asset_price_history_api_spec.rb +53 -57
- data/spec/api/assets_api_spec.rb +99 -114
- data/spec/api/cloud_providers_api_spec.rb +42 -15
- data/spec/api/companies_api_spec.rb +47 -99
- data/spec/api/connections_api_spec.rb +41 -63
- data/spec/api/favorites_api_spec.rb +56 -56
- data/spec/api/users_api_spec.rb +29 -88
- data/spec/models/{postgen_integrations_spec.rb → alert_spec.rb} +17 -17
- data/spec/models/{api_keys_update_spec.rb → apikey_spec.rb} +20 -14
- data/spec/models/{endpoints_spec.rb → asset_spec.rb} +83 -69
- data/spec/models/{api_keys_spec.rb → assetpricehistory_spec.rb} +19 -25
- data/spec/models/{cloud_providers_spec.rb → cloudprovider_spec.rb} +20 -14
- data/spec/models/{companies_spec.rb → company_spec.rb} +16 -26
- data/spec/models/{posts_input_spec.rb → connection_spec.rb} +27 -51
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/{favorites_spec.rb → favorite_spec.rb} +23 -17
- data/spec/models/inline_object1_spec.rb +3 -3
- data/spec/models/inline_object2_spec.rb +3 -3
- data/spec/models/inline_object3_spec.rb +3 -3
- data/spec/models/inline_object_spec.rb +3 -3
- data/spec/models/{api_keys_input_spec.rb → user_spec.rb} +15 -15
- data/spec/spec_helper.rb +2 -2
- data/test.sh +42 -0
- metadata +78 -616
- data/CHANGELOG.md +0 -25
- data/docs/Alerts.md +0 -30
- data/docs/AlertsInput.md +0 -24
- data/docs/AlertsUpdate.md +0 -24
- data/docs/ApiKeys.md +0 -40
- data/docs/ApiKeysInput.md +0 -34
- data/docs/ApiKeysUpdate.md +0 -34
- data/docs/AssetPriceHistory.md +0 -30
- data/docs/AssetPriceHistoryInput.md +0 -24
- data/docs/AssetPriceHistoryUpdate.md +0 -24
- data/docs/AssetUsecases.md +0 -28
- data/docs/AssetUsecasesApi.md +0 -157
- data/docs/Assets.md +0 -142
- data/docs/AssetsInput.md +0 -128
- data/docs/AssetsUpdate.md +0 -128
- data/docs/CloudProviders.md +0 -28
- data/docs/CloudProvidersInput.md +0 -22
- data/docs/CloudProvidersUpdate.md +0 -22
- data/docs/Companies.md +0 -46
- data/docs/CompaniesInput.md +0 -40
- data/docs/CompaniesUpdate.md +0 -40
- data/docs/Connections.md +0 -38
- data/docs/ConnectionsInput.md +0 -32
- data/docs/ConnectionsUpdate.md +0 -32
- data/docs/CreateAlerts200Response.md +0 -20
- data/docs/CreateAlerts200ResponseData.md +0 -18
- data/docs/CreateApiKeys200Response.md +0 -20
- data/docs/CreateApiKeys200ResponseData.md +0 -18
- data/docs/CreateAssetPriceHistory200Response.md +0 -20
- data/docs/CreateAssetPriceHistory200ResponseData.md +0 -18
- data/docs/CreateAssetsAnalyze200Response.md +0 -20
- data/docs/CreateAssetsAnalyze200ResponseData.md +0 -18
- data/docs/CreateConnections200Response.md +0 -20
- data/docs/CreateConnections200ResponseData.md +0 -18
- data/docs/CreateEndpoints200Response.md +0 -20
- data/docs/CreateEndpoints200ResponseData.md +0 -18
- data/docs/CreateFavorites200Response.md +0 -20
- data/docs/CreateFavorites200ResponseData.md +0 -18
- data/docs/CreatePostgenIntegrations200Response.md +0 -20
- data/docs/CreatePostgenIntegrations200ResponseData.md +0 -18
- data/docs/CreatePosts200Response.md +0 -20
- data/docs/CreatePosts200ResponseData.md +0 -18
- data/docs/CreateUsers200Response.md +0 -20
- data/docs/CreateUsers200ResponseData.md +0 -18
- data/docs/DeleteAlerts200Response.md +0 -20
- data/docs/DeleteAlerts200ResponseData.md +0 -18
- data/docs/DeleteApiKeys200Response.md +0 -20
- data/docs/DeleteApiKeys200ResponseData.md +0 -18
- data/docs/DeleteAssetPriceHistory200Response.md +0 -20
- data/docs/DeleteAssetPriceHistory200ResponseData.md +0 -18
- data/docs/DeleteAssets200Response.md +0 -20
- data/docs/DeleteAssets200ResponseData.md +0 -18
- data/docs/DeleteConnections200Response.md +0 -20
- data/docs/DeleteConnections200ResponseData.md +0 -18
- data/docs/DeleteEndpoints200Response.md +0 -20
- data/docs/DeleteEndpoints200ResponseData.md +0 -18
- data/docs/DeleteFavorites200Response.md +0 -20
- data/docs/DeleteFavorites200ResponseData.md +0 -18
- data/docs/DeletePostgenIntegrations200Response.md +0 -20
- data/docs/DeletePostgenIntegrations200ResponseData.md +0 -18
- data/docs/DeletePosts200Response.md +0 -20
- data/docs/DeletePosts200ResponseData.md +0 -18
- data/docs/DeleteUsers200Response.md +0 -20
- data/docs/DeleteUsers200ResponseData.md +0 -18
- data/docs/Endpoints.md +0 -96
- data/docs/EndpointsApi.md +0 -1189
- data/docs/EndpointsInput.md +0 -94
- data/docs/EndpointsUpdate.md +0 -94
- data/docs/Favorites.md +0 -34
- data/docs/FavoritesInput.md +0 -28
- data/docs/FavoritesUpdate.md +0 -28
- data/docs/GetAlertsById200Response.md +0 -20
- data/docs/GetApiKeysById200Response.md +0 -20
- data/docs/GetAssetPriceHistoryById200Response.md +0 -20
- data/docs/GetAssetUsecasesById200Response.md +0 -20
- data/docs/GetAssetsByIdAnalyze200Response.md +0 -20
- data/docs/GetCloudProvidersById200Response.md +0 -20
- data/docs/GetCompaniesById200Response.md +0 -20
- data/docs/GetConnectionsById200Response.md +0 -20
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +0 -20
- data/docs/GetFavoritesById200Response.md +0 -20
- data/docs/GetIndustriesById200Response.md +0 -20
- data/docs/GetJobFunctionsById200Response.md +0 -20
- data/docs/GetPostgenIntegrationsById200Response.md +0 -20
- data/docs/GetPostsById200Response.md +0 -20
- data/docs/GetStorageEnginesById200Response.md +0 -20
- data/docs/GetUsersById200Response.md +0 -20
- data/docs/Industries.md +0 -32
- data/docs/IndustriesApi.md +0 -237
- data/docs/InlineObject4.md +0 -20
- data/docs/InlineObject5.md +0 -20
- data/docs/InlineObject6.md +0 -22
- data/docs/InlineObject7.md +0 -20
- data/docs/JobFunctions.md +0 -24
- data/docs/JobFunctionsApi.md +0 -157
- data/docs/JobFunctionsInput.md +0 -18
- data/docs/JobFunctionsUpdate.md +0 -18
- data/docs/ListApiKeys200Response.md +0 -20
- data/docs/ListAssetUsecases200Response.md +0 -20
- data/docs/ListAssets200Response.md +0 -20
- data/docs/ListCloudProviders200Response.md +0 -20
- data/docs/ListCompaniesAnalyticsAssets200Response.md +0 -20
- data/docs/ListConnections200Response.md +0 -20
- data/docs/ListEndpoints200Response.md +0 -20
- data/docs/ListIndustries200Response.md +0 -20
- data/docs/ListJobFunctions200Response.md +0 -20
- data/docs/ListPostgenIntegrations200Response.md +0 -20
- data/docs/ListPosts200Response.md +0 -20
- data/docs/ListStorageEngines200Response.md +0 -20
- data/docs/ListUsers200Response.md +0 -20
- data/docs/PostPublications.md +0 -40
- data/docs/PostPublicationsInput.md +0 -34
- data/docs/PostPublicationsUpdate.md +0 -34
- data/docs/PostgenIntegrations.md +0 -36
- data/docs/PostgenIntegrationsApi.md +0 -463
- data/docs/PostgenIntegrationsInput.md +0 -30
- data/docs/PostgenIntegrationsUpdate.md +0 -30
- data/docs/Posts.md +0 -68
- data/docs/PostsApi.md +0 -843
- data/docs/PostsInput.md +0 -62
- data/docs/PostsUpdate.md +0 -62
- data/docs/StorageEngines.md +0 -32
- data/docs/StorageEnginesApi.md +0 -161
- data/docs/UpdateAlerts200Response.md +0 -20
- data/docs/UpdateAlerts200ResponseData.md +0 -18
- data/docs/UpdateApiKeys200Response.md +0 -20
- data/docs/UpdateApiKeys200ResponseData.md +0 -18
- data/docs/UpdateAssetPriceHistory200Response.md +0 -20
- data/docs/UpdateAssetPriceHistory200ResponseData.md +0 -18
- data/docs/UpdateAssets200Response.md +0 -20
- data/docs/UpdateAssets200ResponseData.md +0 -18
- data/docs/UpdateCompanies200Response.md +0 -20
- data/docs/UpdateCompanies200ResponseData.md +0 -18
- data/docs/UpdateConnections200Response.md +0 -20
- data/docs/UpdateConnections200ResponseData.md +0 -18
- data/docs/UpdateEndpoints200Response.md +0 -20
- data/docs/UpdateEndpoints200ResponseData.md +0 -18
- data/docs/UpdateFavorites200Response.md +0 -20
- data/docs/UpdateFavorites200ResponseData.md +0 -18
- data/docs/UpdatePostgenIntegrations200Response.md +0 -20
- data/docs/UpdatePostgenIntegrations200ResponseData.md +0 -18
- data/docs/UpdatePosts200Response.md +0 -20
- data/docs/UpdatePosts200ResponseData.md +0 -18
- data/docs/UpdateUsers200Response.md +0 -20
- data/docs/UpdateUsers200ResponseData.md +0 -18
- data/docs/Users.md +0 -36
- data/docs/UsersInput.md +0 -30
- data/docs/UsersUpdate.md +0 -30
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +0 -190
- data/lib/spartera_api_sdk/api/endpoints_api.rb +0 -1613
- data/lib/spartera_api_sdk/api/industries_api.rb +0 -284
- data/lib/spartera_api_sdk/api/job_functions_api.rb +0 -190
- data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +0 -634
- data/lib/spartera_api_sdk/api/posts_api.rb +0 -1190
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +0 -228
- data/lib/spartera_api_sdk/api_model_base.rb +0 -88
- data/lib/spartera_api_sdk/models/alerts_input.rb +0 -213
- data/lib/spartera_api_sdk/models/alerts_update.rb +0 -179
- data/lib/spartera_api_sdk/models/api_keys_input.rb +0 -263
- data/lib/spartera_api_sdk/models/api_keys_update.rb +0 -229
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +0 -179
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +0 -179
- data/lib/spartera_api_sdk/models/asset_usecases.rb +0 -216
- data/lib/spartera_api_sdk/models/assets.rb +0 -1068
- data/lib/spartera_api_sdk/models/assets_input.rb +0 -918
- data/lib/spartera_api_sdk/models/assets_update.rb +0 -877
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +0 -186
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +0 -169
- data/lib/spartera_api_sdk/models/companies_input.rb +0 -327
- data/lib/spartera_api_sdk/models/companies_update.rb +0 -293
- data/lib/spartera_api_sdk/models/connections_input.rb +0 -287
- data/lib/spartera_api_sdk/models/connections_update.rb +0 -253
- data/lib/spartera_api_sdk/models/create_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_assets200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_assets200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/endpoints.rb +0 -788
- data/lib/spartera_api_sdk/models/endpoints_input.rb +0 -686
- data/lib/spartera_api_sdk/models/endpoints_update.rb +0 -635
- data/lib/spartera_api_sdk/models/favorites_input.rb +0 -233
- data/lib/spartera_api_sdk/models/favorites_update.rb +0 -199
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_endpoints_by_id_connections_describe200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_postgen_integrations_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/industries.rb +0 -253
- data/lib/spartera_api_sdk/models/inline_object4.rb +0 -156
- data/lib/spartera_api_sdk/models/inline_object5.rb +0 -156
- data/lib/spartera_api_sdk/models/inline_object6.rb +0 -166
- data/lib/spartera_api_sdk/models/inline_object7.rb +0 -156
- data/lib/spartera_api_sdk/models/job_functions.rb +0 -213
- data/lib/spartera_api_sdk/models/job_functions_input.rb +0 -166
- data/lib/spartera_api_sdk/models/job_functions_update.rb +0 -149
- data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_asset_usecases200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_assets200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_companies_analytics_assets200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_connections200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_industries200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_posts200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_users200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/post_publications.rb +0 -327
- data/lib/spartera_api_sdk/models/post_publications_input.rb +0 -280
- data/lib/spartera_api_sdk/models/post_publications_update.rb +0 -229
- data/lib/spartera_api_sdk/models/postgen_integrations.rb +0 -341
- data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +0 -294
- data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +0 -209
- data/lib/spartera_api_sdk/models/posts.rb +0 -586
- data/lib/spartera_api_sdk/models/posts_input.rb +0 -437
- data/lib/spartera_api_sdk/models/posts_update.rb +0 -369
- data/lib/spartera_api_sdk/models/storage_engines.rb +0 -294
- data/lib/spartera_api_sdk/models/update_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_assets200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_assets200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_companies200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/users_input.rb +0 -260
- data/lib/spartera_api_sdk/models/users_update.rb +0 -243
- data/spec/api/asset_usecases_api_spec.rb +0 -61
- data/spec/api/endpoints_api_spec.rb +0 -240
- data/spec/api/industries_api_spec.rb +0 -76
- data/spec/api/job_functions_api_spec.rb +0 -61
- data/spec/api/postgen_integrations_api_spec.rb +0 -117
- data/spec/api/posts_api_spec.rb +0 -186
- data/spec/api/storage_engines_api_spec.rb +0 -63
- data/spec/models/alerts_input_spec.rb +0 -54
- data/spec/models/alerts_spec.rb +0 -72
- data/spec/models/alerts_update_spec.rb +0 -54
- data/spec/models/asset_price_history_input_spec.rb +0 -54
- data/spec/models/asset_price_history_spec.rb +0 -72
- data/spec/models/asset_price_history_update_spec.rb +0 -54
- data/spec/models/asset_usecases_spec.rb +0 -66
- data/spec/models/assets_input_spec.rb +0 -418
- data/spec/models/assets_spec.rb +0 -464
- data/spec/models/assets_update_spec.rb +0 -418
- data/spec/models/cloud_providers_input_spec.rb +0 -48
- data/spec/models/cloud_providers_update_spec.rb +0 -48
- data/spec/models/companies_input_spec.rb +0 -106
- data/spec/models/companies_update_spec.rb +0 -106
- data/spec/models/connections_input_spec.rb +0 -82
- data/spec/models/connections_spec.rb +0 -100
- data/spec/models/connections_update_spec.rb +0 -82
- data/spec/models/create_alerts200_response_data_spec.rb +0 -36
- data/spec/models/create_alerts200_response_spec.rb +0 -42
- data/spec/models/create_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/create_api_keys200_response_spec.rb +0 -42
- data/spec/models/create_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/create_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/create_assets_analyze200_response_data_spec.rb +0 -36
- data/spec/models/create_assets_analyze200_response_spec.rb +0 -42
- data/spec/models/create_connections200_response_data_spec.rb +0 -36
- data/spec/models/create_connections200_response_spec.rb +0 -42
- data/spec/models/create_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/create_endpoints200_response_spec.rb +0 -42
- data/spec/models/create_favorites200_response_data_spec.rb +0 -36
- data/spec/models/create_favorites200_response_spec.rb +0 -42
- data/spec/models/create_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/create_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/create_posts200_response_data_spec.rb +0 -36
- data/spec/models/create_posts200_response_spec.rb +0 -42
- data/spec/models/create_users200_response_data_spec.rb +0 -36
- data/spec/models/create_users200_response_spec.rb +0 -42
- data/spec/models/delete_alerts200_response_data_spec.rb +0 -36
- data/spec/models/delete_alerts200_response_spec.rb +0 -42
- data/spec/models/delete_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/delete_api_keys200_response_spec.rb +0 -42
- data/spec/models/delete_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/delete_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/delete_assets200_response_data_spec.rb +0 -36
- data/spec/models/delete_assets200_response_spec.rb +0 -42
- data/spec/models/delete_connections200_response_data_spec.rb +0 -36
- data/spec/models/delete_connections200_response_spec.rb +0 -42
- data/spec/models/delete_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/delete_endpoints200_response_spec.rb +0 -42
- data/spec/models/delete_favorites200_response_data_spec.rb +0 -36
- data/spec/models/delete_favorites200_response_spec.rb +0 -42
- data/spec/models/delete_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/delete_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/delete_posts200_response_data_spec.rb +0 -36
- data/spec/models/delete_posts200_response_spec.rb +0 -42
- data/spec/models/delete_users200_response_data_spec.rb +0 -36
- data/spec/models/delete_users200_response_spec.rb +0 -42
- data/spec/models/endpoints_input_spec.rb +0 -292
- data/spec/models/endpoints_update_spec.rb +0 -292
- data/spec/models/favorites_input_spec.rb +0 -66
- data/spec/models/favorites_update_spec.rb +0 -66
- data/spec/models/get_alerts_by_id200_response_spec.rb +0 -42
- data/spec/models/get_api_keys_by_id200_response_spec.rb +0 -42
- data/spec/models/get_asset_price_history_by_id200_response_spec.rb +0 -42
- data/spec/models/get_asset_usecases_by_id200_response_spec.rb +0 -42
- data/spec/models/get_assets_by_id_analyze200_response_spec.rb +0 -42
- data/spec/models/get_cloud_providers_by_id200_response_spec.rb +0 -42
- data/spec/models/get_companies_by_id200_response_spec.rb +0 -42
- data/spec/models/get_connections_by_id200_response_spec.rb +0 -42
- data/spec/models/get_endpoints_by_id_connections_describe200_response_spec.rb +0 -42
- data/spec/models/get_favorites_by_id200_response_spec.rb +0 -42
- data/spec/models/get_industries_by_id200_response_spec.rb +0 -42
- data/spec/models/get_job_functions_by_id200_response_spec.rb +0 -42
- data/spec/models/get_postgen_integrations_by_id200_response_spec.rb +0 -42
- data/spec/models/get_posts_by_id200_response_spec.rb +0 -42
- data/spec/models/get_storage_engines_by_id200_response_spec.rb +0 -42
- data/spec/models/get_users_by_id200_response_spec.rb +0 -42
- data/spec/models/industries_spec.rb +0 -78
- data/spec/models/inline_object4_spec.rb +0 -42
- data/spec/models/inline_object5_spec.rb +0 -42
- data/spec/models/inline_object6_spec.rb +0 -48
- data/spec/models/inline_object7_spec.rb +0 -42
- data/spec/models/job_functions_input_spec.rb +0 -36
- data/spec/models/job_functions_spec.rb +0 -54
- data/spec/models/job_functions_update_spec.rb +0 -36
- data/spec/models/list_api_keys200_response_spec.rb +0 -42
- data/spec/models/list_asset_usecases200_response_spec.rb +0 -42
- data/spec/models/list_assets200_response_spec.rb +0 -42
- data/spec/models/list_cloud_providers200_response_spec.rb +0 -42
- data/spec/models/list_companies_analytics_assets200_response_spec.rb +0 -42
- data/spec/models/list_connections200_response_spec.rb +0 -42
- data/spec/models/list_endpoints200_response_spec.rb +0 -42
- data/spec/models/list_industries200_response_spec.rb +0 -42
- data/spec/models/list_job_functions200_response_spec.rb +0 -42
- data/spec/models/list_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/list_posts200_response_spec.rb +0 -42
- data/spec/models/list_storage_engines200_response_spec.rb +0 -42
- data/spec/models/list_users200_response_spec.rb +0 -42
- data/spec/models/post_publications_input_spec.rb +0 -84
- data/spec/models/post_publications_spec.rb +0 -102
- data/spec/models/post_publications_update_spec.rb +0 -84
- data/spec/models/postgen_integrations_input_spec.rb +0 -72
- data/spec/models/postgen_integrations_update_spec.rb +0 -72
- data/spec/models/posts_spec.rb +0 -186
- data/spec/models/posts_update_spec.rb +0 -168
- data/spec/models/storage_engines_spec.rb +0 -82
- data/spec/models/update_alerts200_response_data_spec.rb +0 -36
- data/spec/models/update_alerts200_response_spec.rb +0 -42
- data/spec/models/update_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/update_api_keys200_response_spec.rb +0 -42
- data/spec/models/update_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/update_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/update_assets200_response_data_spec.rb +0 -36
- data/spec/models/update_assets200_response_spec.rb +0 -42
- data/spec/models/update_companies200_response_data_spec.rb +0 -36
- data/spec/models/update_companies200_response_spec.rb +0 -42
- data/spec/models/update_connections200_response_data_spec.rb +0 -36
- data/spec/models/update_connections200_response_spec.rb +0 -42
- data/spec/models/update_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/update_endpoints200_response_spec.rb +0 -42
- data/spec/models/update_favorites200_response_data_spec.rb +0 -36
- data/spec/models/update_favorites200_response_spec.rb +0 -42
- data/spec/models/update_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/update_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/update_posts200_response_data_spec.rb +0 -36
- data/spec/models/update_posts200_response_spec.rb +0 -42
- data/spec/models/update_users200_response_data_spec.rb +0 -36
- data/spec/models/update_users200_response_spec.rb +0 -42
- data/spec/models/users_input_spec.rb +0 -76
- data/spec/models/users_spec.rb +0 -94
- data/spec/models/users_update_spec.rb +0 -76
data/docs/AlertsApi.md
CHANGED
|
@@ -4,20 +4,20 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
7
|
+
| [**companies_company_id_users_user_id_alerts_alert_id_delete**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID |
|
|
8
|
+
| [**companies_company_id_users_user_id_alerts_alert_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Get single alert by ID |
|
|
9
|
+
| [**companies_company_id_users_user_id_alerts_alert_id_patch**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID |
|
|
10
|
+
| [**companies_company_id_users_user_id_alerts_asset_asset_id_all_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_all_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset (from all users) This would typically be restricted to asset owners or admins |
|
|
11
|
+
| [**companies_company_id_users_user_id_alerts_asset_asset_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset by the specified user Useful for checking if user already has an alert set up for an asset |
|
|
12
|
+
| [**companies_company_id_users_user_id_alerts_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_get) | **GET** /companies/{company_id}/users/{user_id}/alerts | Get a list of all alerts for a specific user |
|
|
13
|
+
| [**companies_company_id_users_user_id_alerts_post**](AlertsApi.md#companies_company_id_users_user_id_alerts_post) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts |
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## companies_company_id_users_user_id_alerts_alert_id_delete
|
|
17
17
|
|
|
18
|
-
>
|
|
18
|
+
> Object companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Delete single alert by ID
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -26,41 +26,39 @@ require 'time'
|
|
|
26
26
|
require 'spartera_api_sdk'
|
|
27
27
|
# setup authorization
|
|
28
28
|
SparteraApiSdk.configure do |config|
|
|
29
|
-
# Configure
|
|
30
|
-
config.
|
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
32
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
29
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
33
31
|
end
|
|
34
32
|
|
|
35
33
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
36
|
-
company_id = 'company_id_example' # String |
|
|
37
|
-
user_id = 'user_id_example' # String |
|
|
38
|
-
|
|
34
|
+
company_id = 'company_id_example' # String |
|
|
35
|
+
user_id = 'user_id_example' # String |
|
|
36
|
+
alert_id = 'alert_id_example' # String |
|
|
39
37
|
|
|
40
38
|
begin
|
|
41
|
-
#
|
|
42
|
-
result = api_instance.
|
|
39
|
+
# Delete single alert by ID
|
|
40
|
+
result = api_instance.companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
|
|
43
41
|
p result
|
|
44
42
|
rescue SparteraApiSdk::ApiError => e
|
|
45
|
-
puts "Error when calling AlertsApi->
|
|
43
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_delete: #{e}"
|
|
46
44
|
end
|
|
47
45
|
```
|
|
48
46
|
|
|
49
|
-
#### Using the
|
|
47
|
+
#### Using the companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info variant
|
|
50
48
|
|
|
51
49
|
This returns an Array which contains the response data, status code and headers.
|
|
52
50
|
|
|
53
|
-
> <Array(
|
|
51
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
|
|
54
52
|
|
|
55
53
|
```ruby
|
|
56
54
|
begin
|
|
57
|
-
#
|
|
58
|
-
data, status_code, headers = api_instance.
|
|
55
|
+
# Delete single alert by ID
|
|
56
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
|
|
59
57
|
p status_code # => 2xx
|
|
60
58
|
p headers # => { ... }
|
|
61
|
-
p data # =>
|
|
59
|
+
p data # => Object
|
|
62
60
|
rescue SparteraApiSdk::ApiError => e
|
|
63
|
-
puts "Error when calling AlertsApi->
|
|
61
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info: #{e}"
|
|
64
62
|
end
|
|
65
63
|
```
|
|
66
64
|
|
|
@@ -68,29 +66,29 @@ end
|
|
|
68
66
|
|
|
69
67
|
| Name | Type | Description | Notes |
|
|
70
68
|
| ---- | ---- | ----------- | ----- |
|
|
71
|
-
| **company_id** | **String** |
|
|
72
|
-
| **user_id** | **String** |
|
|
73
|
-
| **
|
|
69
|
+
| **company_id** | **String** | | |
|
|
70
|
+
| **user_id** | **String** | | |
|
|
71
|
+
| **alert_id** | **String** | | |
|
|
74
72
|
|
|
75
73
|
### Return type
|
|
76
74
|
|
|
77
|
-
|
|
75
|
+
**Object**
|
|
78
76
|
|
|
79
77
|
### Authorization
|
|
80
78
|
|
|
81
|
-
[
|
|
79
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
82
80
|
|
|
83
81
|
### HTTP request headers
|
|
84
82
|
|
|
85
|
-
- **Content-Type**:
|
|
83
|
+
- **Content-Type**: Not defined
|
|
86
84
|
- **Accept**: application/json
|
|
87
85
|
|
|
88
86
|
|
|
89
|
-
##
|
|
87
|
+
## companies_company_id_users_user_id_alerts_alert_id_get
|
|
90
88
|
|
|
91
|
-
>
|
|
89
|
+
> Object companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
|
|
92
90
|
|
|
93
|
-
|
|
91
|
+
Get single alert by ID
|
|
94
92
|
|
|
95
93
|
### Examples
|
|
96
94
|
|
|
@@ -99,41 +97,39 @@ require 'time'
|
|
|
99
97
|
require 'spartera_api_sdk'
|
|
100
98
|
# setup authorization
|
|
101
99
|
SparteraApiSdk.configure do |config|
|
|
102
|
-
# Configure
|
|
103
|
-
config.
|
|
104
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
105
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
100
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
101
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
106
102
|
end
|
|
107
103
|
|
|
108
104
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
109
|
-
company_id = 'company_id_example' # String |
|
|
110
|
-
user_id = 'user_id_example' # String |
|
|
111
|
-
alert_id = 'alert_id_example' # String |
|
|
105
|
+
company_id = 'company_id_example' # String |
|
|
106
|
+
user_id = 'user_id_example' # String |
|
|
107
|
+
alert_id = 'alert_id_example' # String |
|
|
112
108
|
|
|
113
109
|
begin
|
|
114
|
-
#
|
|
115
|
-
result = api_instance.
|
|
110
|
+
# Get single alert by ID
|
|
111
|
+
result = api_instance.companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
|
|
116
112
|
p result
|
|
117
113
|
rescue SparteraApiSdk::ApiError => e
|
|
118
|
-
puts "Error when calling AlertsApi->
|
|
114
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_get: #{e}"
|
|
119
115
|
end
|
|
120
116
|
```
|
|
121
117
|
|
|
122
|
-
#### Using the
|
|
118
|
+
#### Using the companies_company_id_users_user_id_alerts_alert_id_get_with_http_info variant
|
|
123
119
|
|
|
124
120
|
This returns an Array which contains the response data, status code and headers.
|
|
125
121
|
|
|
126
|
-
> <Array(
|
|
122
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
|
|
127
123
|
|
|
128
124
|
```ruby
|
|
129
125
|
begin
|
|
130
|
-
#
|
|
131
|
-
data, status_code, headers = api_instance.
|
|
126
|
+
# Get single alert by ID
|
|
127
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
|
|
132
128
|
p status_code # => 2xx
|
|
133
129
|
p headers # => { ... }
|
|
134
|
-
p data # =>
|
|
130
|
+
p data # => Object
|
|
135
131
|
rescue SparteraApiSdk::ApiError => e
|
|
136
|
-
puts "Error when calling AlertsApi->
|
|
132
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_get_with_http_info: #{e}"
|
|
137
133
|
end
|
|
138
134
|
```
|
|
139
135
|
|
|
@@ -141,17 +137,17 @@ end
|
|
|
141
137
|
|
|
142
138
|
| Name | Type | Description | Notes |
|
|
143
139
|
| ---- | ---- | ----------- | ----- |
|
|
144
|
-
| **company_id** | **String** |
|
|
145
|
-
| **user_id** | **String** |
|
|
146
|
-
| **alert_id** | **String** |
|
|
140
|
+
| **company_id** | **String** | | |
|
|
141
|
+
| **user_id** | **String** | | |
|
|
142
|
+
| **alert_id** | **String** | | |
|
|
147
143
|
|
|
148
144
|
### Return type
|
|
149
145
|
|
|
150
|
-
|
|
146
|
+
**Object**
|
|
151
147
|
|
|
152
148
|
### Authorization
|
|
153
149
|
|
|
154
|
-
[
|
|
150
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
155
151
|
|
|
156
152
|
### HTTP request headers
|
|
157
153
|
|
|
@@ -159,11 +155,11 @@ end
|
|
|
159
155
|
- **Accept**: application/json
|
|
160
156
|
|
|
161
157
|
|
|
162
|
-
##
|
|
158
|
+
## companies_company_id_users_user_id_alerts_alert_id_patch
|
|
163
159
|
|
|
164
|
-
>
|
|
160
|
+
> Object companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
|
|
165
161
|
|
|
166
|
-
|
|
162
|
+
Update an existing alert by ID
|
|
167
163
|
|
|
168
164
|
### Examples
|
|
169
165
|
|
|
@@ -172,40 +168,40 @@ require 'time'
|
|
|
172
168
|
require 'spartera_api_sdk'
|
|
173
169
|
# setup authorization
|
|
174
170
|
SparteraApiSdk.configure do |config|
|
|
175
|
-
# Configure
|
|
176
|
-
config.
|
|
177
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
178
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
171
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
172
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
179
173
|
end
|
|
180
174
|
|
|
181
175
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
182
|
-
company_id = 'company_id_example' # String |
|
|
183
|
-
user_id = 'user_id_example' # String |
|
|
176
|
+
company_id = 'company_id_example' # String |
|
|
177
|
+
user_id = 'user_id_example' # String |
|
|
178
|
+
alert_id = 'alert_id_example' # String |
|
|
179
|
+
alert = SparteraApiSdk::Alert.new({asset_id: 'asset_id_example', company_id: 'company_id_example', alert_type: 'alert_type_example'}) # Alert |
|
|
184
180
|
|
|
185
181
|
begin
|
|
186
|
-
#
|
|
187
|
-
result = api_instance.
|
|
182
|
+
# Update an existing alert by ID
|
|
183
|
+
result = api_instance.companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
|
|
188
184
|
p result
|
|
189
185
|
rescue SparteraApiSdk::ApiError => e
|
|
190
|
-
puts "Error when calling AlertsApi->
|
|
186
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_patch: #{e}"
|
|
191
187
|
end
|
|
192
188
|
```
|
|
193
189
|
|
|
194
|
-
#### Using the
|
|
190
|
+
#### Using the companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info variant
|
|
195
191
|
|
|
196
192
|
This returns an Array which contains the response data, status code and headers.
|
|
197
193
|
|
|
198
|
-
> <Array(
|
|
194
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
|
|
199
195
|
|
|
200
196
|
```ruby
|
|
201
197
|
begin
|
|
202
|
-
#
|
|
203
|
-
data, status_code, headers = api_instance.
|
|
198
|
+
# Update an existing alert by ID
|
|
199
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
|
|
204
200
|
p status_code # => 2xx
|
|
205
201
|
p headers # => { ... }
|
|
206
|
-
p data # =>
|
|
202
|
+
p data # => Object
|
|
207
203
|
rescue SparteraApiSdk::ApiError => e
|
|
208
|
-
puts "Error when calling AlertsApi->
|
|
204
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info: #{e}"
|
|
209
205
|
end
|
|
210
206
|
```
|
|
211
207
|
|
|
@@ -213,28 +209,30 @@ end
|
|
|
213
209
|
|
|
214
210
|
| Name | Type | Description | Notes |
|
|
215
211
|
| ---- | ---- | ----------- | ----- |
|
|
216
|
-
| **company_id** | **String** |
|
|
217
|
-
| **user_id** | **String** |
|
|
212
|
+
| **company_id** | **String** | | |
|
|
213
|
+
| **user_id** | **String** | | |
|
|
214
|
+
| **alert_id** | **String** | | |
|
|
215
|
+
| **alert** | [**Alert**](Alert.md) | | |
|
|
218
216
|
|
|
219
217
|
### Return type
|
|
220
218
|
|
|
221
|
-
|
|
219
|
+
**Object**
|
|
222
220
|
|
|
223
221
|
### Authorization
|
|
224
222
|
|
|
225
|
-
[
|
|
223
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
226
224
|
|
|
227
225
|
### HTTP request headers
|
|
228
226
|
|
|
229
|
-
- **Content-Type**:
|
|
227
|
+
- **Content-Type**: application/json
|
|
230
228
|
- **Accept**: application/json
|
|
231
229
|
|
|
232
230
|
|
|
233
|
-
##
|
|
231
|
+
## companies_company_id_users_user_id_alerts_asset_asset_id_all_get
|
|
234
232
|
|
|
235
|
-
>
|
|
233
|
+
> Object companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
|
|
236
234
|
|
|
237
|
-
Get all alerts for a specific asset
|
|
235
|
+
Get all alerts for a specific asset (from all users) This would typically be restricted to asset owners or admins
|
|
238
236
|
|
|
239
237
|
### Examples
|
|
240
238
|
|
|
@@ -243,41 +241,39 @@ require 'time'
|
|
|
243
241
|
require 'spartera_api_sdk'
|
|
244
242
|
# setup authorization
|
|
245
243
|
SparteraApiSdk.configure do |config|
|
|
246
|
-
# Configure
|
|
247
|
-
config.
|
|
248
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
249
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
244
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
245
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
250
246
|
end
|
|
251
247
|
|
|
252
248
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
253
|
-
company_id = 'company_id_example' # String |
|
|
254
|
-
user_id = 'user_id_example' # String |
|
|
255
|
-
asset_id = 'asset_id_example' # String |
|
|
249
|
+
company_id = 'company_id_example' # String |
|
|
250
|
+
user_id = 'user_id_example' # String |
|
|
251
|
+
asset_id = 'asset_id_example' # String |
|
|
256
252
|
|
|
257
253
|
begin
|
|
258
|
-
# Get all alerts for a specific asset
|
|
259
|
-
result = api_instance.
|
|
254
|
+
# Get all alerts for a specific asset (from all users) This would typically be restricted to asset owners or admins
|
|
255
|
+
result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
|
|
260
256
|
p result
|
|
261
257
|
rescue SparteraApiSdk::ApiError => e
|
|
262
|
-
puts "Error when calling AlertsApi->
|
|
258
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_all_get: #{e}"
|
|
263
259
|
end
|
|
264
260
|
```
|
|
265
261
|
|
|
266
|
-
#### Using the
|
|
262
|
+
#### Using the companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info variant
|
|
267
263
|
|
|
268
264
|
This returns an Array which contains the response data, status code and headers.
|
|
269
265
|
|
|
270
|
-
> <Array(
|
|
266
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
|
|
271
267
|
|
|
272
268
|
```ruby
|
|
273
269
|
begin
|
|
274
|
-
# Get all alerts for a specific asset
|
|
275
|
-
data, status_code, headers = api_instance.
|
|
270
|
+
# Get all alerts for a specific asset (from all users) This would typically be restricted to asset owners or admins
|
|
271
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
|
|
276
272
|
p status_code # => 2xx
|
|
277
273
|
p headers # => { ... }
|
|
278
|
-
p data # =>
|
|
274
|
+
p data # => Object
|
|
279
275
|
rescue SparteraApiSdk::ApiError => e
|
|
280
|
-
puts "Error when calling AlertsApi->
|
|
276
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info: #{e}"
|
|
281
277
|
end
|
|
282
278
|
```
|
|
283
279
|
|
|
@@ -285,17 +281,17 @@ end
|
|
|
285
281
|
|
|
286
282
|
| Name | Type | Description | Notes |
|
|
287
283
|
| ---- | ---- | ----------- | ----- |
|
|
288
|
-
| **company_id** | **String** |
|
|
289
|
-
| **user_id** | **String** |
|
|
290
|
-
| **asset_id** | **String** |
|
|
284
|
+
| **company_id** | **String** | | |
|
|
285
|
+
| **user_id** | **String** | | |
|
|
286
|
+
| **asset_id** | **String** | | |
|
|
291
287
|
|
|
292
288
|
### Return type
|
|
293
289
|
|
|
294
|
-
|
|
290
|
+
**Object**
|
|
295
291
|
|
|
296
292
|
### Authorization
|
|
297
293
|
|
|
298
|
-
[
|
|
294
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
299
295
|
|
|
300
296
|
### HTTP request headers
|
|
301
297
|
|
|
@@ -303,11 +299,11 @@ end
|
|
|
303
299
|
- **Accept**: application/json
|
|
304
300
|
|
|
305
301
|
|
|
306
|
-
##
|
|
302
|
+
## companies_company_id_users_user_id_alerts_asset_asset_id_get
|
|
307
303
|
|
|
308
|
-
>
|
|
304
|
+
> Object companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
|
|
309
305
|
|
|
310
|
-
Get
|
|
306
|
+
Get all alerts for a specific asset by the specified user Useful for checking if user already has an alert set up for an asset
|
|
311
307
|
|
|
312
308
|
### Examples
|
|
313
309
|
|
|
@@ -316,41 +312,39 @@ require 'time'
|
|
|
316
312
|
require 'spartera_api_sdk'
|
|
317
313
|
# setup authorization
|
|
318
314
|
SparteraApiSdk.configure do |config|
|
|
319
|
-
# Configure
|
|
320
|
-
config.
|
|
321
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
322
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
315
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
316
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
323
317
|
end
|
|
324
318
|
|
|
325
319
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
326
|
-
company_id = 'company_id_example' # String |
|
|
327
|
-
user_id = 'user_id_example' # String |
|
|
328
|
-
|
|
320
|
+
company_id = 'company_id_example' # String |
|
|
321
|
+
user_id = 'user_id_example' # String |
|
|
322
|
+
asset_id = 'asset_id_example' # String |
|
|
329
323
|
|
|
330
324
|
begin
|
|
331
|
-
# Get
|
|
332
|
-
result = api_instance.
|
|
325
|
+
# Get all alerts for a specific asset by the specified user Useful for checking if user already has an alert set up for an asset
|
|
326
|
+
result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
|
|
333
327
|
p result
|
|
334
328
|
rescue SparteraApiSdk::ApiError => e
|
|
335
|
-
puts "Error when calling AlertsApi->
|
|
329
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_get: #{e}"
|
|
336
330
|
end
|
|
337
331
|
```
|
|
338
332
|
|
|
339
|
-
#### Using the
|
|
333
|
+
#### Using the companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info variant
|
|
340
334
|
|
|
341
335
|
This returns an Array which contains the response data, status code and headers.
|
|
342
336
|
|
|
343
|
-
> <Array(
|
|
337
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
|
344
338
|
|
|
345
339
|
```ruby
|
|
346
340
|
begin
|
|
347
|
-
# Get
|
|
348
|
-
data, status_code, headers = api_instance.
|
|
341
|
+
# Get all alerts for a specific asset by the specified user Useful for checking if user already has an alert set up for an asset
|
|
342
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
|
349
343
|
p status_code # => 2xx
|
|
350
344
|
p headers # => { ... }
|
|
351
|
-
p data # =>
|
|
345
|
+
p data # => Object
|
|
352
346
|
rescue SparteraApiSdk::ApiError => e
|
|
353
|
-
puts "Error when calling AlertsApi->
|
|
347
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info: #{e}"
|
|
354
348
|
end
|
|
355
349
|
```
|
|
356
350
|
|
|
@@ -358,17 +352,17 @@ end
|
|
|
358
352
|
|
|
359
353
|
| Name | Type | Description | Notes |
|
|
360
354
|
| ---- | ---- | ----------- | ----- |
|
|
361
|
-
| **company_id** | **String** |
|
|
362
|
-
| **user_id** | **String** |
|
|
363
|
-
| **
|
|
355
|
+
| **company_id** | **String** | | |
|
|
356
|
+
| **user_id** | **String** | | |
|
|
357
|
+
| **asset_id** | **String** | | |
|
|
364
358
|
|
|
365
359
|
### Return type
|
|
366
360
|
|
|
367
|
-
|
|
361
|
+
**Object**
|
|
368
362
|
|
|
369
363
|
### Authorization
|
|
370
364
|
|
|
371
|
-
[
|
|
365
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
372
366
|
|
|
373
367
|
### HTTP request headers
|
|
374
368
|
|
|
@@ -376,11 +370,11 @@ end
|
|
|
376
370
|
- **Accept**: application/json
|
|
377
371
|
|
|
378
372
|
|
|
379
|
-
##
|
|
373
|
+
## companies_company_id_users_user_id_alerts_get
|
|
380
374
|
|
|
381
|
-
>
|
|
375
|
+
> Object companies_company_id_users_user_id_alerts_get(company_id, user_id)
|
|
382
376
|
|
|
383
|
-
Get all alerts for a specific
|
|
377
|
+
Get a list of all alerts for a specific user
|
|
384
378
|
|
|
385
379
|
### Examples
|
|
386
380
|
|
|
@@ -389,41 +383,38 @@ require 'time'
|
|
|
389
383
|
require 'spartera_api_sdk'
|
|
390
384
|
# setup authorization
|
|
391
385
|
SparteraApiSdk.configure do |config|
|
|
392
|
-
# Configure
|
|
393
|
-
config.
|
|
394
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
395
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
386
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
387
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
396
388
|
end
|
|
397
389
|
|
|
398
390
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
399
|
-
company_id = 'company_id_example' # String |
|
|
400
|
-
user_id = 'user_id_example' # String |
|
|
401
|
-
asset_id = 'asset_id_example' # String | Unique identifier for the Asset
|
|
391
|
+
company_id = 'company_id_example' # String |
|
|
392
|
+
user_id = 'user_id_example' # String |
|
|
402
393
|
|
|
403
394
|
begin
|
|
404
|
-
# Get all alerts for a specific
|
|
405
|
-
result = api_instance.
|
|
395
|
+
# Get a list of all alerts for a specific user
|
|
396
|
+
result = api_instance.companies_company_id_users_user_id_alerts_get(company_id, user_id)
|
|
406
397
|
p result
|
|
407
398
|
rescue SparteraApiSdk::ApiError => e
|
|
408
|
-
puts "Error when calling AlertsApi->
|
|
399
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_get: #{e}"
|
|
409
400
|
end
|
|
410
401
|
```
|
|
411
402
|
|
|
412
|
-
#### Using the
|
|
403
|
+
#### Using the companies_company_id_users_user_id_alerts_get_with_http_info variant
|
|
413
404
|
|
|
414
405
|
This returns an Array which contains the response data, status code and headers.
|
|
415
406
|
|
|
416
|
-
> <Array(
|
|
407
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
|
|
417
408
|
|
|
418
409
|
```ruby
|
|
419
410
|
begin
|
|
420
|
-
# Get all alerts for a specific
|
|
421
|
-
data, status_code, headers = api_instance.
|
|
411
|
+
# Get a list of all alerts for a specific user
|
|
412
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
|
|
422
413
|
p status_code # => 2xx
|
|
423
414
|
p headers # => { ... }
|
|
424
|
-
p data # =>
|
|
415
|
+
p data # => Object
|
|
425
416
|
rescue SparteraApiSdk::ApiError => e
|
|
426
|
-
puts "Error when calling AlertsApi->
|
|
417
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_get_with_http_info: #{e}"
|
|
427
418
|
end
|
|
428
419
|
```
|
|
429
420
|
|
|
@@ -431,17 +422,16 @@ end
|
|
|
431
422
|
|
|
432
423
|
| Name | Type | Description | Notes |
|
|
433
424
|
| ---- | ---- | ----------- | ----- |
|
|
434
|
-
| **company_id** | **String** |
|
|
435
|
-
| **user_id** | **String** |
|
|
436
|
-
| **asset_id** | **String** | Unique identifier for the Asset | |
|
|
425
|
+
| **company_id** | **String** | | |
|
|
426
|
+
| **user_id** | **String** | | |
|
|
437
427
|
|
|
438
428
|
### Return type
|
|
439
429
|
|
|
440
|
-
|
|
430
|
+
**Object**
|
|
441
431
|
|
|
442
432
|
### Authorization
|
|
443
433
|
|
|
444
|
-
[
|
|
434
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
445
435
|
|
|
446
436
|
### HTTP request headers
|
|
447
437
|
|
|
@@ -449,11 +439,11 @@ end
|
|
|
449
439
|
- **Accept**: application/json
|
|
450
440
|
|
|
451
441
|
|
|
452
|
-
##
|
|
442
|
+
## companies_company_id_users_user_id_alerts_post
|
|
453
443
|
|
|
454
|
-
>
|
|
444
|
+
> Object companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
|
|
455
445
|
|
|
456
|
-
|
|
446
|
+
POST /companies/{company_id}/users/{user_id}/alerts
|
|
457
447
|
|
|
458
448
|
### Examples
|
|
459
449
|
|
|
@@ -462,42 +452,39 @@ require 'time'
|
|
|
462
452
|
require 'spartera_api_sdk'
|
|
463
453
|
# setup authorization
|
|
464
454
|
SparteraApiSdk.configure do |config|
|
|
465
|
-
# Configure
|
|
466
|
-
config.
|
|
467
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
468
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
455
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
456
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
469
457
|
end
|
|
470
458
|
|
|
471
459
|
api_instance = SparteraApiSdk::AlertsApi.new
|
|
472
|
-
company_id = 'company_id_example' # String |
|
|
473
|
-
user_id = 'user_id_example' # String |
|
|
474
|
-
|
|
475
|
-
alerts_update = SparteraApiSdk::AlertsUpdate.new # AlertsUpdate |
|
|
460
|
+
company_id = 'company_id_example' # String |
|
|
461
|
+
user_id = 'user_id_example' # String |
|
|
462
|
+
alert = SparteraApiSdk::Alert.new({asset_id: 'asset_id_example', company_id: 'company_id_example', alert_type: 'alert_type_example'}) # Alert |
|
|
476
463
|
|
|
477
464
|
begin
|
|
478
|
-
#
|
|
479
|
-
result = api_instance.
|
|
465
|
+
# POST /companies/{company_id}/users/{user_id}/alerts
|
|
466
|
+
result = api_instance.companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
|
|
480
467
|
p result
|
|
481
468
|
rescue SparteraApiSdk::ApiError => e
|
|
482
|
-
puts "Error when calling AlertsApi->
|
|
469
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_post: #{e}"
|
|
483
470
|
end
|
|
484
471
|
```
|
|
485
472
|
|
|
486
|
-
#### Using the
|
|
473
|
+
#### Using the companies_company_id_users_user_id_alerts_post_with_http_info variant
|
|
487
474
|
|
|
488
475
|
This returns an Array which contains the response data, status code and headers.
|
|
489
476
|
|
|
490
|
-
> <Array(
|
|
477
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
|
|
491
478
|
|
|
492
479
|
```ruby
|
|
493
480
|
begin
|
|
494
|
-
#
|
|
495
|
-
data, status_code, headers = api_instance.
|
|
481
|
+
# POST /companies/{company_id}/users/{user_id}/alerts
|
|
482
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
|
|
496
483
|
p status_code # => 2xx
|
|
497
484
|
p headers # => { ... }
|
|
498
|
-
p data # =>
|
|
485
|
+
p data # => Object
|
|
499
486
|
rescue SparteraApiSdk::ApiError => e
|
|
500
|
-
puts "Error when calling AlertsApi->
|
|
487
|
+
puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_post_with_http_info: #{e}"
|
|
501
488
|
end
|
|
502
489
|
```
|
|
503
490
|
|
|
@@ -505,18 +492,17 @@ end
|
|
|
505
492
|
|
|
506
493
|
| Name | Type | Description | Notes |
|
|
507
494
|
| ---- | ---- | ----------- | ----- |
|
|
508
|
-
| **company_id** | **String** |
|
|
509
|
-
| **user_id** | **String** |
|
|
510
|
-
| **
|
|
511
|
-
| **alerts_update** | [**AlertsUpdate**](AlertsUpdate.md) | | |
|
|
495
|
+
| **company_id** | **String** | | |
|
|
496
|
+
| **user_id** | **String** | | |
|
|
497
|
+
| **alert** | [**Alert**](Alert.md) | | |
|
|
512
498
|
|
|
513
499
|
### Return type
|
|
514
500
|
|
|
515
|
-
|
|
501
|
+
**Object**
|
|
516
502
|
|
|
517
503
|
### Authorization
|
|
518
504
|
|
|
519
|
-
[
|
|
505
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
520
506
|
|
|
521
507
|
### HTTP request headers
|
|
522
508
|
|