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