spartera_api_sdk 1.0.73 → 1.0.77
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/APIKeysApi.md +210 -60
- data/docs/Alerts.md +30 -0
- data/docs/AlertsApi.md +20 -20
- data/docs/AlertsInput.md +24 -0
- data/docs/AlertsUpdate.md +24 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md → AnalyzeCompanyHandleAssetsAssetSlugGet200Response.md} +3 -3
- data/docs/ApiKeys.md +32 -0
- data/docs/ApiKeysInput.md +26 -0
- data/docs/ApiKeysUpdate.md +26 -0
- data/docs/AssetPriceHistory.md +28 -0
- data/docs/AssetPriceHistoryApi.md +56 -48
- data/docs/AssetPriceHistoryInput.md +22 -0
- data/docs/AssetPriceHistoryUpdate.md +22 -0
- data/docs/Assets.md +108 -0
- data/docs/AssetsApi.md +28 -28
- data/docs/AssetsInput.md +94 -0
- data/docs/AssetsUpdate.md +94 -0
- data/docs/{Cloudprovider.md → CloudProviders.md} +8 -10
- data/docs/CloudProvidersApi.md +8 -8
- data/docs/{CompaniesCompanyIdAssetsAssetIdGet200Response.md → CloudProvidersGet200Response.md} +3 -3
- data/docs/CloudProvidersInput.md +22 -0
- data/docs/CloudProvidersProviderIdGet200Response.md +20 -0
- data/docs/CloudProvidersProviderIdStorageEnginesGet200Response.md +20 -0
- data/docs/CloudProvidersUpdate.md +22 -0
- data/docs/{Company.md → Companies.md} +13 -15
- data/docs/CompaniesApi.md +41 -39
- data/docs/CompaniesCompanyIdAnalyticsAssetsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdApiKeysGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdApiKeysPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdApiKeysPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdConnectionsConnectionIdGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdConnectionsGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +1 -1
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md → CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response.md} +3 -3
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +1 -1
- data/docs/CompaniesCompanyIdUsersUserIdGet200Response.md +1 -1
- data/docs/CompaniesInput.md +36 -0
- data/docs/CompaniesUpdate.md +36 -0
- data/docs/Connections.md +38 -0
- data/docs/ConnectionsApi.md +12 -12
- data/docs/ConnectionsInput.md +32 -0
- data/docs/ConnectionsUpdate.md +32 -0
- data/docs/Favorites.md +34 -0
- data/docs/FavoritesApi.md +24 -24
- data/docs/FavoritesInput.md +28 -0
- data/docs/FavoritesUpdate.md +28 -0
- data/docs/JobFunctions.md +24 -0
- data/docs/JobFunctionsApi.md +144 -0
- data/docs/JobFunctionsFunctionIdGet200Response.md +20 -0
- data/docs/JobFunctionsGet200Response.md +20 -0
- data/docs/JobFunctionsInput.md +18 -0
- data/docs/JobFunctionsUpdate.md +18 -0
- data/docs/StorageEnginesApi.md +8 -8
- data/docs/{User.md → Users.md} +9 -11
- data/docs/UsersApi.md +20 -20
- data/docs/UsersInput.md +26 -0
- data/docs/UsersUpdate.md +26 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +25 -25
- data/lib/spartera_api_sdk/api/api_keys_api.rb +222 -55
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +87 -43
- data/lib/spartera_api_sdk/api/assets_api.rb +37 -37
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +7 -7
- data/lib/spartera_api_sdk/api/companies_api.rb +43 -32
- data/lib/spartera_api_sdk/api/connections_api.rb +19 -19
- data/lib/spartera_api_sdk/api/favorites_api.rb +28 -28
- data/lib/spartera_api_sdk/api/job_functions_api.rb +138 -0
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +7 -7
- data/lib/spartera_api_sdk/api/users_api.rb +24 -24
- data/lib/spartera_api_sdk/api_client.rb +1 -1
- data/lib/spartera_api_sdk/api_error.rb +1 -1
- data/lib/spartera_api_sdk/configuration.rb +1 -1
- data/lib/spartera_api_sdk/models/{alert.rb → alerts.rb} +38 -64
- data/lib/spartera_api_sdk/models/alerts_input.rb +283 -0
- data/lib/spartera_api_sdk/models/{me_get200_response_token_metadata.rb → alerts_update.rb} +31 -34
- data/lib/spartera_api_sdk/models/analyze_company_handle_assets_asset_slug_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/{apikey.rb → api_keys.rb} +34 -64
- data/lib/spartera_api_sdk/models/api_keys_input.rb +296 -0
- data/lib/spartera_api_sdk/models/api_keys_update.rb +262 -0
- data/lib/spartera_api_sdk/models/{assetpricehistory.rb → asset_price_history.rb} +27 -88
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +257 -0
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +240 -0
- data/lib/spartera_api_sdk/models/assets.rb +879 -0
- data/lib/spartera_api_sdk/models/{asset.rb → assets_input.rb} +160 -95
- data/lib/spartera_api_sdk/models/assets_update.rb +710 -0
- data/lib/spartera_api_sdk/models/{cloudprovider.rb → cloud_providers.rb} +27 -36
- data/lib/spartera_api_sdk/models/cloud_providers_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +256 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_get200_response.rb → cloud_providers_provider_id_get200_response.rb} +5 -5
- data/lib/spartera_api_sdk/models/cloud_providers_provider_id_storage_engines_get200_response.rb +246 -0
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +239 -0
- data/lib/spartera_api_sdk/models/{company.rb → companies.rb} +33 -39
- data/lib/spartera_api_sdk/models/companies_company_id_analytics_assets_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_get200_response.rb +22 -4
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_get200_response.rb → companies_company_id_assets_asset_id_prices_aph_id_get200_response.rb} +5 -5
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_asset_asset_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb → companies_company_id_users_user_id_favorites_category_category_get200_response.rb} +5 -5
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_get200_response.rb +2 -2
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response_data.rb +1 -1
- data/lib/spartera_api_sdk/models/companies_input.rb +339 -0
- data/lib/spartera_api_sdk/models/companies_update.rb +305 -0
- data/lib/spartera_api_sdk/models/{connection.rb → connections.rb} +57 -111
- data/lib/spartera_api_sdk/models/connections_input.rb +353 -0
- data/lib/spartera_api_sdk/models/connections_update.rb +319 -0
- data/lib/spartera_api_sdk/models/error.rb +1 -1
- data/lib/spartera_api_sdk/models/{favorite.rb → favorites.rb} +30 -36
- data/lib/spartera_api_sdk/models/favorites_input.rb +303 -0
- data/lib/spartera_api_sdk/models/favorites_update.rb +269 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +1 -1
- data/lib/spartera_api_sdk/models/inline_object1.rb +1 -1
- data/lib/spartera_api_sdk/models/inline_object2.rb +1 -1
- data/lib/spartera_api_sdk/models/inline_object3.rb +1 -1
- data/lib/spartera_api_sdk/models/job_functions.rb +282 -0
- data/lib/spartera_api_sdk/models/job_functions_function_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/job_functions_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/{me_get200_response_api_key_info.rb → job_functions_input.rb} +29 -23
- data/lib/spartera_api_sdk/models/job_functions_update.rb +221 -0
- data/lib/spartera_api_sdk/models/{user.rb → users.rb} +56 -40
- data/lib/spartera_api_sdk/models/{me_get200_response_profile.rb → users_input.rb} +35 -71
- data/lib/spartera_api_sdk/models/users_update.rb +292 -0
- data/lib/spartera_api_sdk/version.rb +1 -1
- data/lib/spartera_api_sdk.rb +59 -17
- data/spec/api/alerts_api_spec.rb +5 -5
- data/spec/api/api_keys_api_spec.rb +43 -16
- data/spec/api/asset_price_history_api_spec.rb +14 -10
- data/spec/api/assets_api_spec.rb +7 -7
- data/spec/api/cloud_providers_api_spec.rb +3 -3
- data/spec/api/companies_api_spec.rb +11 -10
- data/spec/api/connections_api_spec.rb +3 -3
- data/spec/api/favorites_api_spec.rb +6 -6
- data/spec/api/job_functions_api_spec.rb +56 -0
- data/spec/api/storage_engines_api_spec.rb +3 -3
- data/spec/api/users_api_spec.rb +5 -5
- data/spec/models/{me_get200_response_token_metadata_spec.rb → alerts_input_spec.rb} +11 -11
- data/spec/models/alerts_spec.rb +72 -0
- data/spec/models/alerts_update_spec.rb +54 -0
- data/spec/models/analyze_company_handle_assets_asset_slug_get200_response_spec.rb +42 -0
- data/spec/models/api_keys_input_spec.rb +60 -0
- data/spec/models/{apikey_spec.rb → api_keys_spec.rb} +15 -27
- data/spec/models/api_keys_update_spec.rb +60 -0
- data/spec/models/asset_price_history_input_spec.rb +48 -0
- data/spec/models/asset_price_history_spec.rb +66 -0
- data/spec/models/asset_price_history_update_spec.rb +48 -0
- data/spec/models/assets_input_spec.rb +300 -0
- data/spec/models/{asset_spec.rb → assets_spec.rb} +59 -25
- data/spec/models/assets_update_spec.rb +300 -0
- data/spec/models/cloud_providers_get200_response_spec.rb +42 -0
- data/spec/models/cloud_providers_input_spec.rb +48 -0
- data/spec/models/cloud_providers_provider_id_get200_response_spec.rb +42 -0
- data/spec/models/cloud_providers_provider_id_storage_engines_get200_response_spec.rb +42 -0
- data/spec/models/{cloudprovider_spec.rb → cloud_providers_spec.rb} +13 -19
- data/spec/models/cloud_providers_update_spec.rb +48 -0
- data/spec/models/companies_company_id_analytics_assets_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_api_keys_api_key_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_api_keys_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_api_keys_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_api_keys_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_asset_id_get200_response_spec.rb → companies_company_id_assets_asset_id_prices_get200_response_spec.rb} +7 -7
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_post200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_assets_post200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_post200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_post200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_post200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +1 -1
- data/spec/models/{companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb → companies_company_id_users_user_id_alerts_asset_asset_id_get200_response_spec.rb} +7 -7
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_delete200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_delete200_response_spec.rb +1 -1
- data/spec/models/{companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb → companies_company_id_users_user_id_favorites_category_category_get200_response_spec.rb} +7 -7
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_patch200_response_data_spec.rb +1 -1
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +1 -1
- data/spec/models/{alert_spec.rb → companies_input_spec.rb} +17 -17
- data/spec/models/{company_spec.rb → companies_spec.rb} +19 -25
- data/spec/models/companies_update_spec.rb +90 -0
- data/spec/models/connections_input_spec.rb +82 -0
- data/spec/models/{me_get200_response_profile_spec.rb → connections_spec.rb} +27 -21
- data/spec/models/connections_update_spec.rb +82 -0
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/favorites_input_spec.rb +66 -0
- data/spec/models/{favorite_spec.rb → favorites_spec.rb} +16 -22
- data/spec/models/favorites_update_spec.rb +66 -0
- data/spec/models/inline_object1_spec.rb +1 -1
- data/spec/models/inline_object2_spec.rb +1 -1
- data/spec/models/inline_object3_spec.rb +1 -1
- data/spec/models/inline_object_spec.rb +1 -1
- data/spec/models/job_functions_function_id_get200_response_spec.rb +42 -0
- data/spec/models/{me_get200_response_api_key_info_spec.rb → job_functions_get200_response_spec.rb} +9 -9
- 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/users_input_spec.rb +64 -0
- data/spec/models/{user_spec.rb → users_spec.rb} +19 -21
- data/spec/models/users_update_spec.rb +64 -0
- metadata +285 -123
- data/docs/Alert.md +0 -36
- data/docs/Apikey.md +0 -36
- data/docs/Asset.md +0 -110
- data/docs/Assetpricehistory.md +0 -38
- data/docs/Connection.md +0 -54
- data/docs/Favorite.md +0 -36
- data/docs/MeGet200Response.md +0 -36
- data/docs/MeGet200ResponseApiKeyInfo.md +0 -20
- data/docs/MeGet200ResponseProfile.md +0 -36
- data/docs/MeGet200ResponseTokenMetadata.md +0 -24
- data/example.rb +0 -51
- data/lib/spartera_api_sdk/models/me_get200_response.rb +0 -417
- data/spec/models/assetpricehistory_spec.rb +0 -96
- data/spec/models/connection_spec.rb +0 -144
- data/spec/models/me_get200_response_spec.rb +0 -94
- data/spec/spec_helper.rb +0 -111
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 12bb6bea44230426835c4b1125245f0d8b51a65ba2b433f5af62fd320e284b38
|
|
4
|
+
data.tar.gz: 65dd73b2faad38d07fb251362a3086ec6eda0b4cd98c587447331a8b5ea2d064
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1f2e1c4c9820f789d533e63cff83fef1a6233a7ebdd5905315a0ca501b4151385f442b03fc7f33ea5401d818ec1b85fc80af1decd764c0d7baf8ad1e32ff33b3
|
|
7
|
+
data.tar.gz: 9d90089822dce221f3e3dca5cb35aea312f5ea1f2d7598e52137be5c6af63c981f53df0409ed56134404c0173cc95b73aa502a82a7c00937a038a927cb093a9e
|
data/docs/APIKeysApi.md
CHANGED
|
@@ -4,18 +4,91 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
7
|
+
| [**companies_company_id_api_keys_api_key_id_delete**](APIKeysApi.md#companies_company_id_api_keys_api_key_id_delete) | **DELETE** /companies/{company_id}/api-keys/{api_key_id} | Delete (deactivate) single API key by api_key_id. Uses the api_key_id returned during creation for clean identification. Fixed to use correct primary key lookup. |
|
|
8
|
+
| [**companies_company_id_api_keys_api_key_id_get**](APIKeysApi.md#companies_company_id_api_keys_api_key_id_get) | **GET** /companies/{company_id}/api-keys/{api_key_id} | Get single API key by ID. Returns masked API key for security (sk_****1234). |
|
|
9
|
+
| [**companies_company_id_api_keys_api_key_id_patch**](APIKeysApi.md#companies_company_id_api_keys_api_key_id_patch) | **PATCH** /companies/{company_id}/api-keys/{api_key_id} | Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security). |
|
|
10
|
+
| [**companies_company_id_api_keys_api_key_id_revoke_post**](APIKeysApi.md#companies_company_id_api_keys_api_key_id_revoke_post) | **POST** /companies/{company_id}/api-keys/{api_key_id}/revoke | Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata. |
|
|
11
|
+
| [**companies_company_id_api_keys_api_key_id_stats_get**](APIKeysApi.md#companies_company_id_api_keys_api_key_id_stats_get) | **GET** /companies/{company_id}/api-keys/{api_key_id}/stats | Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc. |
|
|
12
|
+
| [**companies_company_id_api_keys_get**](APIKeysApi.md#companies_company_id_api_keys_get) | **GET** /companies/{company_id}/api-keys | Get all API keys for a company. Returns masked API keys for security (sk_****1234). |
|
|
13
|
+
| [**companies_company_id_api_keys_post**](APIKeysApi.md#companies_company_id_api_keys_post) | **POST** /companies/{company_id}/api-keys | Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations. |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## companies_company_id_api_keys_api_key_id_delete
|
|
17
|
+
|
|
18
|
+
> <CompaniesCompanyIdApiKeysApiKeyIdDelete200Response> companies_company_id_api_keys_api_key_id_delete(company_id, api_key_id)
|
|
19
|
+
|
|
20
|
+
Delete (deactivate) single API key by api_key_id. Uses the api_key_id returned during creation for clean identification. Fixed to use correct primary key lookup.
|
|
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::APIKeysApi.new
|
|
36
|
+
company_id = 'company_id_example' # String |
|
|
37
|
+
api_key_id = 'api_key_id_example' # String |
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Delete (deactivate) single API key by api_key_id. Uses the api_key_id returned during creation for clean identification. Fixed to use correct primary key lookup.
|
|
41
|
+
result = api_instance.companies_company_id_api_keys_api_key_id_delete(company_id, api_key_id)
|
|
42
|
+
p result
|
|
43
|
+
rescue SparteraApiSdk::ApiError => e
|
|
44
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_delete: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the companies_company_id_api_keys_api_key_id_delete_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<CompaniesCompanyIdApiKeysApiKeyIdDelete200Response>, Integer, Hash)> companies_company_id_api_keys_api_key_id_delete_with_http_info(company_id, api_key_id)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# Delete (deactivate) single API key by api_key_id. Uses the api_key_id returned during creation for clean identification. Fixed to use correct primary key lookup.
|
|
57
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_delete_with_http_info(company_id, api_key_id)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <CompaniesCompanyIdApiKeysApiKeyIdDelete200Response>
|
|
61
|
+
rescue SparteraApiSdk::ApiError => e
|
|
62
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_delete_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **company_id** | **String** | | |
|
|
71
|
+
| **api_key_id** | **String** | | |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
[**CompaniesCompanyIdApiKeysApiKeyIdDelete200Response**](CompaniesCompanyIdApiKeysApiKeyIdDelete200Response.md)
|
|
76
|
+
|
|
77
|
+
### Authorization
|
|
78
|
+
|
|
79
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
80
|
+
|
|
81
|
+
### HTTP request headers
|
|
82
|
+
|
|
83
|
+
- **Content-Type**: Not defined
|
|
84
|
+
- **Accept**: application/json
|
|
12
85
|
|
|
13
86
|
|
|
14
87
|
## companies_company_id_api_keys_api_key_id_get
|
|
15
88
|
|
|
16
|
-
> <
|
|
89
|
+
> <CompaniesCompanyIdApiKeysApiKeyIdGet200Response> companies_company_id_api_keys_api_key_id_get(company_id, api_key_id)
|
|
17
90
|
|
|
18
|
-
Get single API key by ID
|
|
91
|
+
Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
19
92
|
|
|
20
93
|
### Examples
|
|
21
94
|
|
|
@@ -35,7 +108,7 @@ company_id = 'company_id_example' # String |
|
|
|
35
108
|
api_key_id = 'api_key_id_example' # String |
|
|
36
109
|
|
|
37
110
|
begin
|
|
38
|
-
# Get single API key by ID
|
|
111
|
+
# Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
39
112
|
result = api_instance.companies_company_id_api_keys_api_key_id_get(company_id, api_key_id)
|
|
40
113
|
p result
|
|
41
114
|
rescue SparteraApiSdk::ApiError => e
|
|
@@ -47,15 +120,15 @@ end
|
|
|
47
120
|
|
|
48
121
|
This returns an Array which contains the response data, status code and headers.
|
|
49
122
|
|
|
50
|
-
> <Array(<
|
|
123
|
+
> <Array(<CompaniesCompanyIdApiKeysApiKeyIdGet200Response>, Integer, Hash)> companies_company_id_api_keys_api_key_id_get_with_http_info(company_id, api_key_id)
|
|
51
124
|
|
|
52
125
|
```ruby
|
|
53
126
|
begin
|
|
54
|
-
# Get single API key by ID
|
|
127
|
+
# Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
55
128
|
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_get_with_http_info(company_id, api_key_id)
|
|
56
129
|
p status_code # => 2xx
|
|
57
130
|
p headers # => { ... }
|
|
58
|
-
p data # => <
|
|
131
|
+
p data # => <CompaniesCompanyIdApiKeysApiKeyIdGet200Response>
|
|
59
132
|
rescue SparteraApiSdk::ApiError => e
|
|
60
133
|
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_get_with_http_info: #{e}"
|
|
61
134
|
end
|
|
@@ -70,7 +143,7 @@ end
|
|
|
70
143
|
|
|
71
144
|
### Return type
|
|
72
145
|
|
|
73
|
-
[**
|
|
146
|
+
[**CompaniesCompanyIdApiKeysApiKeyIdGet200Response**](CompaniesCompanyIdApiKeysApiKeyIdGet200Response.md)
|
|
74
147
|
|
|
75
148
|
### Authorization
|
|
76
149
|
|
|
@@ -84,9 +157,9 @@ end
|
|
|
84
157
|
|
|
85
158
|
## companies_company_id_api_keys_api_key_id_patch
|
|
86
159
|
|
|
87
|
-
> <
|
|
160
|
+
> <CompaniesCompanyIdApiKeysApiKeyIdPatch200Response> companies_company_id_api_keys_api_key_id_patch(company_id, api_key_id, api_keys_update)
|
|
88
161
|
|
|
89
|
-
Update an existing API key by ID
|
|
162
|
+
Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
90
163
|
|
|
91
164
|
### Examples
|
|
92
165
|
|
|
@@ -104,10 +177,11 @@ end
|
|
|
104
177
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
105
178
|
company_id = 'company_id_example' # String |
|
|
106
179
|
api_key_id = 'api_key_id_example' # String |
|
|
180
|
+
api_keys_update = SparteraApiSdk::ApiKeysUpdate.new # ApiKeysUpdate |
|
|
107
181
|
|
|
108
182
|
begin
|
|
109
|
-
# Update an existing API key by ID
|
|
110
|
-
result = api_instance.companies_company_id_api_keys_api_key_id_patch(company_id, api_key_id)
|
|
183
|
+
# Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
184
|
+
result = api_instance.companies_company_id_api_keys_api_key_id_patch(company_id, api_key_id, api_keys_update)
|
|
111
185
|
p result
|
|
112
186
|
rescue SparteraApiSdk::ApiError => e
|
|
113
187
|
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_patch: #{e}"
|
|
@@ -118,15 +192,15 @@ end
|
|
|
118
192
|
|
|
119
193
|
This returns an Array which contains the response data, status code and headers.
|
|
120
194
|
|
|
121
|
-
> <Array(<
|
|
195
|
+
> <Array(<CompaniesCompanyIdApiKeysApiKeyIdPatch200Response>, Integer, Hash)> companies_company_id_api_keys_api_key_id_patch_with_http_info(company_id, api_key_id, api_keys_update)
|
|
122
196
|
|
|
123
197
|
```ruby
|
|
124
198
|
begin
|
|
125
|
-
# Update an existing API key by ID
|
|
126
|
-
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_patch_with_http_info(company_id, api_key_id)
|
|
199
|
+
# Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
200
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_patch_with_http_info(company_id, api_key_id, api_keys_update)
|
|
127
201
|
p status_code # => 2xx
|
|
128
202
|
p headers # => { ... }
|
|
129
|
-
p data # => <
|
|
203
|
+
p data # => <CompaniesCompanyIdApiKeysApiKeyIdPatch200Response>
|
|
130
204
|
rescue SparteraApiSdk::ApiError => e
|
|
131
205
|
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_patch_with_http_info: #{e}"
|
|
132
206
|
end
|
|
@@ -138,10 +212,11 @@ end
|
|
|
138
212
|
| ---- | ---- | ----------- | ----- |
|
|
139
213
|
| **company_id** | **String** | | |
|
|
140
214
|
| **api_key_id** | **String** | | |
|
|
215
|
+
| **api_keys_update** | [**ApiKeysUpdate**](ApiKeysUpdate.md) | | |
|
|
141
216
|
|
|
142
217
|
### Return type
|
|
143
218
|
|
|
144
|
-
[**
|
|
219
|
+
[**CompaniesCompanyIdApiKeysApiKeyIdPatch200Response**](CompaniesCompanyIdApiKeysApiKeyIdPatch200Response.md)
|
|
145
220
|
|
|
146
221
|
### Authorization
|
|
147
222
|
|
|
@@ -149,15 +224,15 @@ end
|
|
|
149
224
|
|
|
150
225
|
### HTTP request headers
|
|
151
226
|
|
|
152
|
-
- **Content-Type**:
|
|
227
|
+
- **Content-Type**: application/json
|
|
153
228
|
- **Accept**: application/json
|
|
154
229
|
|
|
155
230
|
|
|
156
|
-
##
|
|
231
|
+
## companies_company_id_api_keys_api_key_id_revoke_post
|
|
157
232
|
|
|
158
|
-
> <
|
|
233
|
+
> <CompaniesCompanyIdApiKeysPost200Response> companies_company_id_api_keys_api_key_id_revoke_post(company_id, api_key_id, api_keys_input)
|
|
159
234
|
|
|
160
|
-
|
|
235
|
+
Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
161
236
|
|
|
162
237
|
### Examples
|
|
163
238
|
|
|
@@ -174,31 +249,33 @@ end
|
|
|
174
249
|
|
|
175
250
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
176
251
|
company_id = 'company_id_example' # String |
|
|
252
|
+
api_key_id = 'api_key_id_example' # String |
|
|
253
|
+
api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_example', role_id: 3.56}) # ApiKeysInput |
|
|
177
254
|
|
|
178
255
|
begin
|
|
179
|
-
#
|
|
180
|
-
result = api_instance.
|
|
256
|
+
# Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
257
|
+
result = api_instance.companies_company_id_api_keys_api_key_id_revoke_post(company_id, api_key_id, api_keys_input)
|
|
181
258
|
p result
|
|
182
259
|
rescue SparteraApiSdk::ApiError => e
|
|
183
|
-
puts "Error when calling APIKeysApi->
|
|
260
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_revoke_post: #{e}"
|
|
184
261
|
end
|
|
185
262
|
```
|
|
186
263
|
|
|
187
|
-
#### Using the
|
|
264
|
+
#### Using the companies_company_id_api_keys_api_key_id_revoke_post_with_http_info variant
|
|
188
265
|
|
|
189
266
|
This returns an Array which contains the response data, status code and headers.
|
|
190
267
|
|
|
191
|
-
> <Array(<
|
|
268
|
+
> <Array(<CompaniesCompanyIdApiKeysPost200Response>, Integer, Hash)> companies_company_id_api_keys_api_key_id_revoke_post_with_http_info(company_id, api_key_id, api_keys_input)
|
|
192
269
|
|
|
193
270
|
```ruby
|
|
194
271
|
begin
|
|
195
|
-
#
|
|
196
|
-
data, status_code, headers = api_instance.
|
|
272
|
+
# Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
273
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_revoke_post_with_http_info(company_id, api_key_id, api_keys_input)
|
|
197
274
|
p status_code # => 2xx
|
|
198
275
|
p headers # => { ... }
|
|
199
|
-
p data # => <
|
|
276
|
+
p data # => <CompaniesCompanyIdApiKeysPost200Response>
|
|
200
277
|
rescue SparteraApiSdk::ApiError => e
|
|
201
|
-
puts "Error when calling APIKeysApi->
|
|
278
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_revoke_post_with_http_info: #{e}"
|
|
202
279
|
end
|
|
203
280
|
```
|
|
204
281
|
|
|
@@ -207,10 +284,12 @@ end
|
|
|
207
284
|
| Name | Type | Description | Notes |
|
|
208
285
|
| ---- | ---- | ----------- | ----- |
|
|
209
286
|
| **company_id** | **String** | | |
|
|
287
|
+
| **api_key_id** | **String** | | |
|
|
288
|
+
| **api_keys_input** | [**ApiKeysInput**](ApiKeysInput.md) | | |
|
|
210
289
|
|
|
211
290
|
### Return type
|
|
212
291
|
|
|
213
|
-
[**
|
|
292
|
+
[**CompaniesCompanyIdApiKeysPost200Response**](CompaniesCompanyIdApiKeysPost200Response.md)
|
|
214
293
|
|
|
215
294
|
### Authorization
|
|
216
295
|
|
|
@@ -218,15 +297,15 @@ end
|
|
|
218
297
|
|
|
219
298
|
### HTTP request headers
|
|
220
299
|
|
|
221
|
-
- **Content-Type**:
|
|
300
|
+
- **Content-Type**: application/json
|
|
222
301
|
- **Accept**: application/json
|
|
223
302
|
|
|
224
303
|
|
|
225
|
-
##
|
|
304
|
+
## companies_company_id_api_keys_api_key_id_stats_get
|
|
226
305
|
|
|
227
|
-
> <CompaniesCompanyIdApiKeysGet200Response>
|
|
306
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_api_keys_api_key_id_stats_get(company_id, api_key_id)
|
|
228
307
|
|
|
229
|
-
|
|
308
|
+
Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
230
309
|
|
|
231
310
|
### Examples
|
|
232
311
|
|
|
@@ -243,31 +322,32 @@ end
|
|
|
243
322
|
|
|
244
323
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
245
324
|
company_id = 'company_id_example' # String |
|
|
325
|
+
api_key_id = 'api_key_id_example' # String |
|
|
246
326
|
|
|
247
327
|
begin
|
|
248
|
-
#
|
|
249
|
-
result = api_instance.
|
|
328
|
+
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
329
|
+
result = api_instance.companies_company_id_api_keys_api_key_id_stats_get(company_id, api_key_id)
|
|
250
330
|
p result
|
|
251
331
|
rescue SparteraApiSdk::ApiError => e
|
|
252
|
-
puts "Error when calling APIKeysApi->
|
|
332
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_stats_get: #{e}"
|
|
253
333
|
end
|
|
254
334
|
```
|
|
255
335
|
|
|
256
|
-
#### Using the
|
|
336
|
+
#### Using the companies_company_id_api_keys_api_key_id_stats_get_with_http_info variant
|
|
257
337
|
|
|
258
338
|
This returns an Array which contains the response data, status code and headers.
|
|
259
339
|
|
|
260
|
-
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)>
|
|
340
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_api_keys_api_key_id_stats_get_with_http_info(company_id, api_key_id)
|
|
261
341
|
|
|
262
342
|
```ruby
|
|
263
343
|
begin
|
|
264
|
-
#
|
|
265
|
-
data, status_code, headers = api_instance.
|
|
344
|
+
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
345
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_api_key_id_stats_get_with_http_info(company_id, api_key_id)
|
|
266
346
|
p status_code # => 2xx
|
|
267
347
|
p headers # => { ... }
|
|
268
348
|
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
|
269
349
|
rescue SparteraApiSdk::ApiError => e
|
|
270
|
-
puts "Error when calling APIKeysApi->
|
|
350
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_api_key_id_stats_get_with_http_info: #{e}"
|
|
271
351
|
end
|
|
272
352
|
```
|
|
273
353
|
|
|
@@ -276,6 +356,7 @@ end
|
|
|
276
356
|
| Name | Type | Description | Notes |
|
|
277
357
|
| ---- | ---- | ----------- | ----- |
|
|
278
358
|
| **company_id** | **String** | | |
|
|
359
|
+
| **api_key_id** | **String** | | |
|
|
279
360
|
|
|
280
361
|
### Return type
|
|
281
362
|
|
|
@@ -291,11 +372,11 @@ end
|
|
|
291
372
|
- **Accept**: application/json
|
|
292
373
|
|
|
293
374
|
|
|
294
|
-
##
|
|
375
|
+
## companies_company_id_api_keys_get
|
|
295
376
|
|
|
296
|
-
> <CompaniesCompanyIdApiKeysGet200Response>
|
|
377
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_api_keys_get(company_id)
|
|
297
378
|
|
|
298
|
-
|
|
379
|
+
Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
299
380
|
|
|
300
381
|
### Examples
|
|
301
382
|
|
|
@@ -312,32 +393,31 @@ end
|
|
|
312
393
|
|
|
313
394
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
314
395
|
company_id = 'company_id_example' # String |
|
|
315
|
-
token = 'token_example' # String |
|
|
316
396
|
|
|
317
397
|
begin
|
|
318
|
-
#
|
|
319
|
-
result = api_instance.
|
|
398
|
+
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
399
|
+
result = api_instance.companies_company_id_api_keys_get(company_id)
|
|
320
400
|
p result
|
|
321
401
|
rescue SparteraApiSdk::ApiError => e
|
|
322
|
-
puts "Error when calling APIKeysApi->
|
|
402
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_get: #{e}"
|
|
323
403
|
end
|
|
324
404
|
```
|
|
325
405
|
|
|
326
|
-
#### Using the
|
|
406
|
+
#### Using the companies_company_id_api_keys_get_with_http_info variant
|
|
327
407
|
|
|
328
408
|
This returns an Array which contains the response data, status code and headers.
|
|
329
409
|
|
|
330
|
-
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)>
|
|
410
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_api_keys_get_with_http_info(company_id)
|
|
331
411
|
|
|
332
412
|
```ruby
|
|
333
413
|
begin
|
|
334
|
-
#
|
|
335
|
-
data, status_code, headers = api_instance.
|
|
414
|
+
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
415
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_get_with_http_info(company_id)
|
|
336
416
|
p status_code # => 2xx
|
|
337
417
|
p headers # => { ... }
|
|
338
418
|
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
|
339
419
|
rescue SparteraApiSdk::ApiError => e
|
|
340
|
-
puts "Error when calling APIKeysApi->
|
|
420
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_get_with_http_info: #{e}"
|
|
341
421
|
end
|
|
342
422
|
```
|
|
343
423
|
|
|
@@ -346,7 +426,6 @@ end
|
|
|
346
426
|
| Name | Type | Description | Notes |
|
|
347
427
|
| ---- | ---- | ----------- | ----- |
|
|
348
428
|
| **company_id** | **String** | | |
|
|
349
|
-
| **token** | **String** | | |
|
|
350
429
|
|
|
351
430
|
### Return type
|
|
352
431
|
|
|
@@ -361,3 +440,74 @@ end
|
|
|
361
440
|
- **Content-Type**: Not defined
|
|
362
441
|
- **Accept**: application/json
|
|
363
442
|
|
|
443
|
+
|
|
444
|
+
## companies_company_id_api_keys_post
|
|
445
|
+
|
|
446
|
+
> <CompaniesCompanyIdApiKeysPost200Response> companies_company_id_api_keys_post(company_id, api_keys_input)
|
|
447
|
+
|
|
448
|
+
Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
449
|
+
|
|
450
|
+
### Examples
|
|
451
|
+
|
|
452
|
+
```ruby
|
|
453
|
+
require 'time'
|
|
454
|
+
require 'spartera_api_sdk'
|
|
455
|
+
# setup authorization
|
|
456
|
+
SparteraApiSdk.configure do |config|
|
|
457
|
+
# Configure API key authorization: ApiKeyAuth
|
|
458
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
460
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
461
|
+
end
|
|
462
|
+
|
|
463
|
+
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
464
|
+
company_id = 'company_id_example' # String |
|
|
465
|
+
api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_example', role_id: 3.56}) # ApiKeysInput |
|
|
466
|
+
|
|
467
|
+
begin
|
|
468
|
+
# Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
469
|
+
result = api_instance.companies_company_id_api_keys_post(company_id, api_keys_input)
|
|
470
|
+
p result
|
|
471
|
+
rescue SparteraApiSdk::ApiError => e
|
|
472
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_post: #{e}"
|
|
473
|
+
end
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
#### Using the companies_company_id_api_keys_post_with_http_info variant
|
|
477
|
+
|
|
478
|
+
This returns an Array which contains the response data, status code and headers.
|
|
479
|
+
|
|
480
|
+
> <Array(<CompaniesCompanyIdApiKeysPost200Response>, Integer, Hash)> companies_company_id_api_keys_post_with_http_info(company_id, api_keys_input)
|
|
481
|
+
|
|
482
|
+
```ruby
|
|
483
|
+
begin
|
|
484
|
+
# Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
485
|
+
data, status_code, headers = api_instance.companies_company_id_api_keys_post_with_http_info(company_id, api_keys_input)
|
|
486
|
+
p status_code # => 2xx
|
|
487
|
+
p headers # => { ... }
|
|
488
|
+
p data # => <CompaniesCompanyIdApiKeysPost200Response>
|
|
489
|
+
rescue SparteraApiSdk::ApiError => e
|
|
490
|
+
puts "Error when calling APIKeysApi->companies_company_id_api_keys_post_with_http_info: #{e}"
|
|
491
|
+
end
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### Parameters
|
|
495
|
+
|
|
496
|
+
| Name | Type | Description | Notes |
|
|
497
|
+
| ---- | ---- | ----------- | ----- |
|
|
498
|
+
| **company_id** | **String** | | |
|
|
499
|
+
| **api_keys_input** | [**ApiKeysInput**](ApiKeysInput.md) | | |
|
|
500
|
+
|
|
501
|
+
### Return type
|
|
502
|
+
|
|
503
|
+
[**CompaniesCompanyIdApiKeysPost200Response**](CompaniesCompanyIdApiKeysPost200Response.md)
|
|
504
|
+
|
|
505
|
+
### Authorization
|
|
506
|
+
|
|
507
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
508
|
+
|
|
509
|
+
### HTTP request headers
|
|
510
|
+
|
|
511
|
+
- **Content-Type**: application/json
|
|
512
|
+
- **Accept**: application/json
|
|
513
|
+
|
data/docs/Alerts.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# SparteraApiSdk::Alerts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date_created** | **Time** | | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | | [optional] |
|
|
9
|
+
| **alert_id** | **Integer** | | [optional] |
|
|
10
|
+
| **asset_id** | **String** | | |
|
|
11
|
+
| **user_id** | **String** | | [optional] |
|
|
12
|
+
| **company_id** | **String** | | |
|
|
13
|
+
| **is_active** | **Boolean** | Whether this alert is currently active | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'spartera_api_sdk'
|
|
19
|
+
|
|
20
|
+
instance = SparteraApiSdk::Alerts.new(
|
|
21
|
+
date_created: null,
|
|
22
|
+
last_updated: null,
|
|
23
|
+
alert_id: null,
|
|
24
|
+
asset_id: null,
|
|
25
|
+
user_id: null,
|
|
26
|
+
company_id: null,
|
|
27
|
+
is_active: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|