spartera_api_sdk 1.0.74 → 1.0.78
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/CHANGELOG.md +5 -0
- data/Gemfile +9 -0
- data/README.md +333 -324
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +261 -87
- data/docs/Alerts.md +30 -0
- data/docs/AlertsApi.md +139 -139
- 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 +162 -154
- 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 +138 -0
- data/docs/AssetsApi.md +534 -206
- data/docs/AssetsInput.md +124 -0
- data/docs/AssetsUpdate.md +124 -0
- data/docs/CloudProviders.md +28 -0
- data/docs/CloudProvidersApi.md +44 -31
- data/docs/CloudProvidersInput.md +22 -0
- data/docs/CloudProvidersUpdate.md +22 -0
- data/docs/Companies.md +46 -0
- data/docs/CompaniesApi.md +312 -144
- data/docs/CompaniesInput.md +40 -0
- data/docs/CompaniesUpdate.md +40 -0
- data/docs/Connections.md +38 -0
- data/docs/ConnectionsApi.md +149 -125
- data/docs/ConnectionsInput.md +32 -0
- data/docs/ConnectionsUpdate.md +32 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdGet200Response.md → CreateAlerts200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md → CreateAlerts200ResponseData.md} +2 -2
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/CreateApiKeys200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → CreateAssetPriceHistory200Response.md} +3 -3
- data/docs/CreateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/CreateAssetsAnalyze200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsPost200ResponseData.md → CreateAssetsAnalyze200ResponseData.md} +2 -2
- data/docs/CreateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsPost200ResponseData.md → CreateConnections200ResponseData.md} +2 -2
- data/docs/CreateEndpoints200Response.md +20 -0
- data/docs/CreateEndpoints200ResponseData.md +18 -0
- data/docs/CreateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md → CreateFavorites200ResponseData.md} +2 -2
- data/docs/CreatePostgenIntegrations200Response.md +20 -0
- data/docs/CreatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdAssetsGet200Response.md → CreatePosts200Response.md} +3 -3
- data/docs/CreatePosts200ResponseData.md +18 -0
- data/docs/CreateUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersPost200ResponseData.md → CreateUsers200ResponseData.md} +2 -2
- data/docs/DeleteAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md → DeleteAlerts200ResponseData.md} +2 -2
- 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/{CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md → DeleteAssets200ResponseData.md} +2 -2
- data/docs/DeleteConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md → DeleteConnections200ResponseData.md} +2 -2
- data/docs/DeleteEndpoints200Response.md +20 -0
- data/docs/DeleteEndpoints200ResponseData.md +18 -0
- data/docs/DeleteFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md → DeleteFavorites200ResponseData.md} +2 -2
- 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/{CompaniesCompanyIdUsersUserIdDelete200ResponseData.md → DeleteUsers200ResponseData.md} +2 -2
- data/docs/Endpoints.md +80 -0
- data/docs/EndpointsApi.md +1043 -0
- data/docs/EndpointsInput.md +78 -0
- data/docs/EndpointsUpdate.md +78 -0
- data/docs/Favorites.md +34 -0
- data/docs/FavoritesApi.md +159 -159
- data/docs/FavoritesInput.md +28 -0
- data/docs/FavoritesUpdate.md +28 -0
- data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetAlertsById200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersGet200Response.md → GetApiKeysById200Response.md} +3 -3
- 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/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/{CompaniesCompanyIdApiKeysGet200Response.md → ListCompaniesAnalyticsAssets200Response.md} +3 -3
- 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/{CompaniesCompanyIdConnectionsGet200Response.md → ListPostgenIntegrations200Response.md} +3 -3
- 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 +40 -28
- data/docs/UpdateAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md → UpdateAlerts200ResponseData.md} +2 -2
- 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/{CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md → UpdateAssets200ResponseData.md} +2 -2
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/UpdateCompanies200ResponseData.md +18 -0
- data/docs/UpdateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md → UpdateConnections200ResponseData.md} +2 -2
- data/docs/UpdateEndpoints200Response.md +20 -0
- data/docs/UpdateEndpoints200ResponseData.md +18 -0
- data/docs/UpdateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md → UpdateFavorites200ResponseData.md} +2 -2
- 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/{CompaniesCompanyIdUsersUserIdPatch200ResponseData.md → UpdateUsers200ResponseData.md} +2 -2
- data/docs/Users.md +36 -0
- data/docs/UsersApi.md +306 -101
- 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 +414 -167
- data/lib/spartera_api_sdk/api/api_keys_api.rb +491 -90
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +460 -169
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +952 -228
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +83 -31
- data/lib/spartera_api_sdk/api/companies_api.rb +651 -137
- data/lib/spartera_api_sdk/api/connections_api.rb +376 -142
- data/lib/spartera_api_sdk/api/endpoints_api.rb +1416 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +456 -196
- 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 +107 -29
- data/lib/spartera_api_sdk/api/users_api.rb +581 -112
- data/lib/spartera_api_sdk/api_client.rb +8 -4
- data/lib/spartera_api_sdk/api_error.rb +2 -2
- data/lib/spartera_api_sdk/api_model_base.rb +88 -0
- data/lib/spartera_api_sdk/configuration.rb +2 -2
- data/lib/spartera_api_sdk/models/{alert.rb → alerts.rb} +46 -139
- 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/{apikey.rb → api_keys.rb} +98 -124
- 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 +1048 -0
- data/lib/spartera_api_sdk/models/assets_input.rb +898 -0
- data/lib/spartera_api_sdk/models/assets_update.rb +857 -0
- data/lib/spartera_api_sdk/models/{cloudprovider.rb → cloud_providers.rb} +35 -111
- 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/{company.rb → companies.rb} +90 -105
- 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/{connection.rb → connections.rb} +69 -186
- 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/{companies_company_id_users_user_id_get200_response.rb → create_alerts200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_post200_response_data.rb → create_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_get200_response.rb → create_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{me_get200_response_api_key_info.rb → create_api_keys200_response_data.rb} +27 -94
- data/lib/spartera_api_sdk/models/{companies_company_id_users_post200_response.rb → create_asset_price_history200_response.rb} +6 -79
- 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/{companies_company_id_assets_post200_response_data.rb → create_assets_analyze200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_post200_response_data.rb → create_connections200_response_data.rb} +5 -78
- 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/{companies_company_id_users_user_id_favorites_post200_response_data.rb → create_favorites200_response_data.rb} +5 -78
- 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/{companies_company_id_users_post200_response_data.rb → create_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb → delete_alerts200_response_data.rb} +5 -78
- 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/{companies_company_id_assets_asset_id_delete200_response_data.rb → delete_assets200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_delete200_response_data.rb → delete_connections200_response_data.rb} +5 -78
- 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/{companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb → delete_favorites200_response_data.rb} +5 -78
- 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/{companies_company_id_users_user_id_delete200_response_data.rb → delete_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/endpoints.rb +684 -0
- data/lib/spartera_api_sdk/models/endpoints_input.rb +582 -0
- data/lib/spartera_api_sdk/models/endpoints_update.rb +531 -0
- data/lib/spartera_api_sdk/models/error.rb +3 -76
- data/lib/spartera_api_sdk/models/{favorite.rb → favorites.rb} +38 -111
- 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/{companies_company_id_users_user_id_delete200_response.rb → get_endpoints_by_id_connections_describe200_response.rb} +6 -79
- 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/{companies_company_id_users_get200_response.rb → get_postgen_integrations_by_id200_response.rb} +7 -82
- 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 +3 -76
- data/lib/spartera_api_sdk/models/inline_object1.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object2.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object3.rb +3 -76
- 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/{companies_company_id_api_keys_get200_response.rb → inline_object6.rb} +22 -104
- 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/{companies_company_id_assets_get200_response.rb → list_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_get200_response.rb → list_asset_usecases200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_get200_response.rb → list_assets200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_post200_response.rb → list_companies_analytics_assets200_response.rb} +9 -80
- 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/{companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb → update_alerts200_response_data.rb} +5 -78
- 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/{companies_company_id_assets_asset_id_patch200_response_data.rb → update_assets200_response_data.rb} +5 -78
- 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/{companies_company_id_connections_connection_id_patch200_response_data.rb → update_connections200_response_data.rb} +5 -78
- 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/{companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb → update_favorites200_response_data.rb} +5 -78
- 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/{companies_company_id_users_user_id_patch200_response_data.rb → update_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{user.rb → users.rb} +112 -108
- data/lib/spartera_api_sdk/models/{me_get200_response_profile.rb → users_input.rb} +54 -139
- data/lib/spartera_api_sdk/models/{me_get200_response_token_metadata.rb → users_update.rb} +101 -110
- data/lib/spartera_api_sdk/version.rb +13 -1
- data/lib/spartera_api_sdk.rb +149 -56
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +50 -50
- data/spec/api/api_keys_api_spec.rb +67 -30
- data/spec/api/asset_price_history_api_spec.rb +57 -53
- data/spec/api/asset_usecases_api_spec.rb +61 -0
- data/spec/api/assets_api_spec.rb +134 -69
- data/spec/api/cloud_providers_api_spec.rb +16 -11
- data/spec/api/companies_api_spec.rb +99 -47
- data/spec/api/connections_api_spec.rb +53 -43
- data/spec/api/endpoints_api_spec.rb +215 -0
- data/spec/api/favorites_api_spec.rb +56 -56
- 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 +16 -11
- data/spec/api/users_api_spec.rb +83 -34
- data/spec/models/{me_get200_response_token_metadata_spec.rb → alerts_input_spec.rb} +12 -12
- data/spec/models/alerts_spec.rb +72 -0
- data/spec/models/alerts_update_spec.rb +54 -0
- data/spec/models/{apikey_spec.rb → api_keys_input_spec.rb} +14 -20
- data/spec/models/{assetpricehistory_spec.rb → api_keys_spec.rb} +25 -19
- data/spec/models/{user_spec.rb → api_keys_update_spec.rb} +15 -15
- 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/{asset_spec.rb → assets_input_spec.rb} +122 -28
- data/spec/models/assets_spec.rb +452 -0
- data/spec/models/assets_update_spec.rb +406 -0
- data/spec/models/{companies_company_id_assets_asset_id_get200_response_spec.rb → cloud_providers_input_spec.rb} +16 -10
- data/spec/models/{cloudprovider_spec.rb → cloud_providers_spec.rb} +14 -20
- data/spec/models/{companies_company_id_assets_asset_id_delete200_response_spec.rb → cloud_providers_update_spec.rb} +16 -10
- data/spec/models/companies_input_spec.rb +106 -0
- data/spec/models/{company_spec.rb → companies_spec.rb} +26 -16
- data/spec/models/companies_update_spec.rb +106 -0
- data/spec/models/connections_input_spec.rb +82 -0
- data/spec/models/{me_get200_response_spec.rb → connections_spec.rb} +28 -22
- 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/{companies_company_id_assets_post200_response_spec.rb → create_asset_price_history200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_assets_post200_response_data_spec.rb → create_assets_analyze200_response_data_spec.rb} +8 -8
- data/spec/models/{companies_company_id_users_post200_response_spec.rb → create_assets_analyze200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_connections_post200_response_data_spec.rb → create_connections200_response_data_spec.rb} +8 -8
- 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/{companies_company_id_users_post200_response_data_spec.rb → create_users200_response_data_spec.rb} +8 -8
- 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/{companies_company_id_assets_asset_id_patch200_response_data_spec.rb → delete_assets200_response_data_spec.rb} +8 -8
- 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/{companies_company_id_users_user_id_patch200_response_data_spec.rb → delete_users200_response_data_spec.rb} +8 -8
- data/spec/models/delete_users200_response_spec.rb +42 -0
- data/spec/models/endpoints_input_spec.rb +236 -0
- data/spec/models/endpoints_spec.rb +242 -0
- data/spec/models/endpoints_update_spec.rb +236 -0
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/favorites_input_spec.rb +66 -0
- data/spec/models/{favorite_spec.rb → favorites_spec.rb} +17 -23
- data/spec/models/favorites_update_spec.rb +66 -0
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_get200_response_spec.rb → get_api_keys_by_id200_response_spec.rb} +8 -8
- 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/{companies_company_id_users_user_id_delete200_response_spec.rb → get_endpoints_by_id_connections_describe200_response_spec.rb} +8 -8
- 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/{companies_company_id_users_get200_response_spec.rb → get_postgen_integrations_by_id200_response_spec.rb} +8 -8
- 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 +3 -3
- data/spec/models/inline_object2_spec.rb +3 -3
- data/spec/models/inline_object3_spec.rb +3 -3
- data/spec/models/inline_object4_spec.rb +42 -0
- data/spec/models/inline_object5_spec.rb +42 -0
- data/spec/models/{companies_company_id_connections_get200_response_spec.rb → inline_object6_spec.rb} +15 -9
- data/spec/models/inline_object7_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +3 -3
- 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/{companies_company_id_api_keys_get200_response_spec.rb → list_companies_analytics_assets200_response_spec.rb} +8 -8
- 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/{alert_spec.rb → postgen_integrations_spec.rb} +17 -17
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/{connection_spec.rb → posts_input_spec.rb} +51 -27
- 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/{companies_company_id_users_user_id_delete200_response_data_spec.rb → update_users200_response_data_spec.rb} +8 -8
- data/spec/models/update_users200_response_spec.rb +42 -0
- data/spec/models/users_input_spec.rb +76 -0
- data/spec/models/{me_get200_response_profile_spec.rb → users_spec.rb} +22 -22
- data/spec/models/users_update_spec.rb +76 -0
- data/spec/spec_helper.rb +2 -2
- metadata +623 -283
- 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/Cloudprovider.md +0 -30
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +0 -20
- data/docs/Company.md +0 -44
- 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/docs/User.md +0 -34
- data/example.rb +0 -51
- data/lib/spartera_api_sdk/models/asset.rb +0 -686
- data/lib/spartera_api_sdk/models/assetpricehistory.rb +0 -345
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/me_get200_response.rb +0 -417
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +0 -42
- data/spec/models/me_get200_response_api_key_info_spec.rb +0 -42
data/Rakefile
ADDED
data/docs/APIKeysApi.md
CHANGED
|
@@ -4,18 +4,20 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
7
|
+
| [**create_api_keys**](APIKeysApi.md#create_api_keys) | **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. |
|
|
8
|
+
| [**create_api_keys_api_keys_revoke**](APIKeysApi.md#create_api_keys_api_keys_revoke) | **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. |
|
|
9
|
+
| [**delete_api_keys**](APIKeysApi.md#delete_api_keys) | **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. |
|
|
10
|
+
| [**get_api_keys_by_id**](APIKeysApi.md#get_api_keys_by_id) | **GET** /companies/{company_id}/api-keys/{api_key_id} | Get single API key by ID. Returns masked API key for security (sk_****1234). |
|
|
11
|
+
| [**get_api_keys_by_id_api_keys_stats**](APIKeysApi.md#get_api_keys_by_id_api_keys_stats) | **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
|
+
| [**list_api_keys**](APIKeysApi.md#list_api_keys) | **GET** /companies/{company_id}/api-keys | Get all API keys for a company. Returns masked API keys for security (sk_****1234). |
|
|
13
|
+
| [**update_api_keys**](APIKeysApi.md#update_api_keys) | **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). |
|
|
12
14
|
|
|
13
15
|
|
|
14
|
-
##
|
|
16
|
+
## create_api_keys
|
|
15
17
|
|
|
16
|
-
> <
|
|
18
|
+
> <CreateApiKeys200Response> create_api_keys(company_id, api_keys_input, opts)
|
|
17
19
|
|
|
18
|
-
|
|
20
|
+
Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
19
21
|
|
|
20
22
|
### Examples
|
|
21
23
|
|
|
@@ -31,33 +33,40 @@ SparteraApiSdk.configure do |config|
|
|
|
31
33
|
end
|
|
32
34
|
|
|
33
35
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
34
|
-
company_id = 'company_id_example' # String |
|
|
35
|
-
|
|
36
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
37
|
+
api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_abc123', role_id: 1}) # ApiKeysInput |
|
|
38
|
+
opts = {
|
|
39
|
+
page: 56, # Integer | Page number for pagination
|
|
40
|
+
limit: 56, # Integer | Number of items per page
|
|
41
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
42
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
43
|
+
search: 'search_example' # String | Search term to filter results
|
|
44
|
+
}
|
|
36
45
|
|
|
37
46
|
begin
|
|
38
|
-
#
|
|
39
|
-
result = api_instance.
|
|
47
|
+
# Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
48
|
+
result = api_instance.create_api_keys(company_id, api_keys_input, opts)
|
|
40
49
|
p result
|
|
41
50
|
rescue SparteraApiSdk::ApiError => e
|
|
42
|
-
puts "Error when calling APIKeysApi->
|
|
51
|
+
puts "Error when calling APIKeysApi->create_api_keys: #{e}"
|
|
43
52
|
end
|
|
44
53
|
```
|
|
45
54
|
|
|
46
|
-
#### Using the
|
|
55
|
+
#### Using the create_api_keys_with_http_info variant
|
|
47
56
|
|
|
48
57
|
This returns an Array which contains the response data, status code and headers.
|
|
49
58
|
|
|
50
|
-
> <Array(<
|
|
59
|
+
> <Array(<CreateApiKeys200Response>, Integer, Hash)> create_api_keys_with_http_info(company_id, api_keys_input, opts)
|
|
51
60
|
|
|
52
61
|
```ruby
|
|
53
62
|
begin
|
|
54
|
-
#
|
|
55
|
-
data, status_code, headers = api_instance.
|
|
63
|
+
# Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
64
|
+
data, status_code, headers = api_instance.create_api_keys_with_http_info(company_id, api_keys_input, opts)
|
|
56
65
|
p status_code # => 2xx
|
|
57
66
|
p headers # => { ... }
|
|
58
|
-
p data # => <
|
|
67
|
+
p data # => <CreateApiKeys200Response>
|
|
59
68
|
rescue SparteraApiSdk::ApiError => e
|
|
60
|
-
puts "Error when calling APIKeysApi->
|
|
69
|
+
puts "Error when calling APIKeysApi->create_api_keys_with_http_info: #{e}"
|
|
61
70
|
end
|
|
62
71
|
```
|
|
63
72
|
|
|
@@ -65,12 +74,17 @@ end
|
|
|
65
74
|
|
|
66
75
|
| Name | Type | Description | Notes |
|
|
67
76
|
| ---- | ---- | ----------- | ----- |
|
|
68
|
-
| **company_id** | **String** |
|
|
69
|
-
| **
|
|
77
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
78
|
+
| **api_keys_input** | [**ApiKeysInput**](ApiKeysInput.md) | | |
|
|
79
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
80
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
81
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
82
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
83
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
70
84
|
|
|
71
85
|
### Return type
|
|
72
86
|
|
|
73
|
-
[**
|
|
87
|
+
[**CreateApiKeys200Response**](CreateApiKeys200Response.md)
|
|
74
88
|
|
|
75
89
|
### Authorization
|
|
76
90
|
|
|
@@ -78,15 +92,88 @@ end
|
|
|
78
92
|
|
|
79
93
|
### HTTP request headers
|
|
80
94
|
|
|
81
|
-
- **Content-Type**:
|
|
95
|
+
- **Content-Type**: application/json
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## create_api_keys_api_keys_revoke
|
|
100
|
+
|
|
101
|
+
> <CreateApiKeys200Response> create_api_keys_api_keys_revoke(company_id, api_key_id, api_keys_input)
|
|
102
|
+
|
|
103
|
+
Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
104
|
+
|
|
105
|
+
### Examples
|
|
106
|
+
|
|
107
|
+
```ruby
|
|
108
|
+
require 'time'
|
|
109
|
+
require 'spartera_api_sdk'
|
|
110
|
+
# setup authorization
|
|
111
|
+
SparteraApiSdk.configure do |config|
|
|
112
|
+
# Configure API key authorization: ApiKeyAuth
|
|
113
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
119
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
120
|
+
api_key_id = 'api_key_id_example' # String | Unique identifier for the Api Key
|
|
121
|
+
api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_abc123', role_id: 1}) # ApiKeysInput |
|
|
122
|
+
|
|
123
|
+
begin
|
|
124
|
+
# Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
125
|
+
result = api_instance.create_api_keys_api_keys_revoke(company_id, api_key_id, api_keys_input)
|
|
126
|
+
p result
|
|
127
|
+
rescue SparteraApiSdk::ApiError => e
|
|
128
|
+
puts "Error when calling APIKeysApi->create_api_keys_api_keys_revoke: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
#### Using the create_api_keys_api_keys_revoke_with_http_info variant
|
|
133
|
+
|
|
134
|
+
This returns an Array which contains the response data, status code and headers.
|
|
135
|
+
|
|
136
|
+
> <Array(<CreateApiKeys200Response>, Integer, Hash)> create_api_keys_api_keys_revoke_with_http_info(company_id, api_key_id, api_keys_input)
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
begin
|
|
140
|
+
# Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
141
|
+
data, status_code, headers = api_instance.create_api_keys_api_keys_revoke_with_http_info(company_id, api_key_id, api_keys_input)
|
|
142
|
+
p status_code # => 2xx
|
|
143
|
+
p headers # => { ... }
|
|
144
|
+
p data # => <CreateApiKeys200Response>
|
|
145
|
+
rescue SparteraApiSdk::ApiError => e
|
|
146
|
+
puts "Error when calling APIKeysApi->create_api_keys_api_keys_revoke_with_http_info: #{e}"
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
| Name | Type | Description | Notes |
|
|
153
|
+
| ---- | ---- | ----------- | ----- |
|
|
154
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
155
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
156
|
+
| **api_keys_input** | [**ApiKeysInput**](ApiKeysInput.md) | | |
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
[**CreateApiKeys200Response**](CreateApiKeys200Response.md)
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: application/json
|
|
82
169
|
- **Accept**: application/json
|
|
83
170
|
|
|
84
171
|
|
|
85
|
-
##
|
|
172
|
+
## delete_api_keys
|
|
86
173
|
|
|
87
|
-
> <
|
|
174
|
+
> <DeleteApiKeys200Response> delete_api_keys(company_id, api_key_id)
|
|
88
175
|
|
|
89
|
-
|
|
176
|
+
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.
|
|
90
177
|
|
|
91
178
|
### Examples
|
|
92
179
|
|
|
@@ -102,33 +189,33 @@ SparteraApiSdk.configure do |config|
|
|
|
102
189
|
end
|
|
103
190
|
|
|
104
191
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
105
|
-
company_id = 'company_id_example' # String |
|
|
106
|
-
api_key_id = 'api_key_id_example' # String |
|
|
192
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
193
|
+
api_key_id = 'api_key_id_example' # String | Unique identifier for the Api Key
|
|
107
194
|
|
|
108
195
|
begin
|
|
109
|
-
#
|
|
110
|
-
result = api_instance.
|
|
196
|
+
# 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.
|
|
197
|
+
result = api_instance.delete_api_keys(company_id, api_key_id)
|
|
111
198
|
p result
|
|
112
199
|
rescue SparteraApiSdk::ApiError => e
|
|
113
|
-
puts "Error when calling APIKeysApi->
|
|
200
|
+
puts "Error when calling APIKeysApi->delete_api_keys: #{e}"
|
|
114
201
|
end
|
|
115
202
|
```
|
|
116
203
|
|
|
117
|
-
#### Using the
|
|
204
|
+
#### Using the delete_api_keys_with_http_info variant
|
|
118
205
|
|
|
119
206
|
This returns an Array which contains the response data, status code and headers.
|
|
120
207
|
|
|
121
|
-
> <Array(<
|
|
208
|
+
> <Array(<DeleteApiKeys200Response>, Integer, Hash)> delete_api_keys_with_http_info(company_id, api_key_id)
|
|
122
209
|
|
|
123
210
|
```ruby
|
|
124
211
|
begin
|
|
125
|
-
#
|
|
126
|
-
data, status_code, headers = api_instance.
|
|
212
|
+
# 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.
|
|
213
|
+
data, status_code, headers = api_instance.delete_api_keys_with_http_info(company_id, api_key_id)
|
|
127
214
|
p status_code # => 2xx
|
|
128
215
|
p headers # => { ... }
|
|
129
|
-
p data # => <
|
|
216
|
+
p data # => <DeleteApiKeys200Response>
|
|
130
217
|
rescue SparteraApiSdk::ApiError => e
|
|
131
|
-
puts "Error when calling APIKeysApi->
|
|
218
|
+
puts "Error when calling APIKeysApi->delete_api_keys_with_http_info: #{e}"
|
|
132
219
|
end
|
|
133
220
|
```
|
|
134
221
|
|
|
@@ -136,12 +223,12 @@ end
|
|
|
136
223
|
|
|
137
224
|
| Name | Type | Description | Notes |
|
|
138
225
|
| ---- | ---- | ----------- | ----- |
|
|
139
|
-
| **company_id** | **String** |
|
|
140
|
-
| **api_key_id** | **String** |
|
|
226
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
227
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
141
228
|
|
|
142
229
|
### Return type
|
|
143
230
|
|
|
144
|
-
[**
|
|
231
|
+
[**DeleteApiKeys200Response**](DeleteApiKeys200Response.md)
|
|
145
232
|
|
|
146
233
|
### Authorization
|
|
147
234
|
|
|
@@ -153,11 +240,11 @@ end
|
|
|
153
240
|
- **Accept**: application/json
|
|
154
241
|
|
|
155
242
|
|
|
156
|
-
##
|
|
243
|
+
## get_api_keys_by_id
|
|
157
244
|
|
|
158
|
-
> <
|
|
245
|
+
> <GetApiKeysById200Response> get_api_keys_by_id(company_id, api_key_id)
|
|
159
246
|
|
|
160
|
-
Get
|
|
247
|
+
Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
161
248
|
|
|
162
249
|
### Examples
|
|
163
250
|
|
|
@@ -173,32 +260,33 @@ SparteraApiSdk.configure do |config|
|
|
|
173
260
|
end
|
|
174
261
|
|
|
175
262
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
176
|
-
company_id = 'company_id_example' # String |
|
|
263
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
264
|
+
api_key_id = 'api_key_id_example' # String | Unique identifier for the Api Key
|
|
177
265
|
|
|
178
266
|
begin
|
|
179
|
-
# Get
|
|
180
|
-
result = api_instance.
|
|
267
|
+
# Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
268
|
+
result = api_instance.get_api_keys_by_id(company_id, api_key_id)
|
|
181
269
|
p result
|
|
182
270
|
rescue SparteraApiSdk::ApiError => e
|
|
183
|
-
puts "Error when calling APIKeysApi->
|
|
271
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id: #{e}"
|
|
184
272
|
end
|
|
185
273
|
```
|
|
186
274
|
|
|
187
|
-
#### Using the
|
|
275
|
+
#### Using the get_api_keys_by_id_with_http_info variant
|
|
188
276
|
|
|
189
277
|
This returns an Array which contains the response data, status code and headers.
|
|
190
278
|
|
|
191
|
-
> <Array(<
|
|
279
|
+
> <Array(<GetApiKeysById200Response>, Integer, Hash)> get_api_keys_by_id_with_http_info(company_id, api_key_id)
|
|
192
280
|
|
|
193
281
|
```ruby
|
|
194
282
|
begin
|
|
195
|
-
# Get
|
|
196
|
-
data, status_code, headers = api_instance.
|
|
283
|
+
# Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
284
|
+
data, status_code, headers = api_instance.get_api_keys_by_id_with_http_info(company_id, api_key_id)
|
|
197
285
|
p status_code # => 2xx
|
|
198
286
|
p headers # => { ... }
|
|
199
|
-
p data # => <
|
|
287
|
+
p data # => <GetApiKeysById200Response>
|
|
200
288
|
rescue SparteraApiSdk::ApiError => e
|
|
201
|
-
puts "Error when calling APIKeysApi->
|
|
289
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_with_http_info: #{e}"
|
|
202
290
|
end
|
|
203
291
|
```
|
|
204
292
|
|
|
@@ -206,11 +294,12 @@ end
|
|
|
206
294
|
|
|
207
295
|
| Name | Type | Description | Notes |
|
|
208
296
|
| ---- | ---- | ----------- | ----- |
|
|
209
|
-
| **company_id** | **String** |
|
|
297
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
298
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
210
299
|
|
|
211
300
|
### Return type
|
|
212
301
|
|
|
213
|
-
[**
|
|
302
|
+
[**GetApiKeysById200Response**](GetApiKeysById200Response.md)
|
|
214
303
|
|
|
215
304
|
### Authorization
|
|
216
305
|
|
|
@@ -222,11 +311,11 @@ end
|
|
|
222
311
|
- **Accept**: application/json
|
|
223
312
|
|
|
224
313
|
|
|
225
|
-
##
|
|
314
|
+
## get_api_keys_by_id_api_keys_stats
|
|
226
315
|
|
|
227
|
-
> <
|
|
316
|
+
> <GetApiKeysById200Response> get_api_keys_by_id_api_keys_stats(company_id, api_key_id)
|
|
228
317
|
|
|
229
|
-
|
|
318
|
+
Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
230
319
|
|
|
231
320
|
### Examples
|
|
232
321
|
|
|
@@ -242,32 +331,33 @@ SparteraApiSdk.configure do |config|
|
|
|
242
331
|
end
|
|
243
332
|
|
|
244
333
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
245
|
-
company_id = 'company_id_example' # String |
|
|
334
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
335
|
+
api_key_id = 'api_key_id_example' # String | Unique identifier for the Api Key
|
|
246
336
|
|
|
247
337
|
begin
|
|
248
|
-
#
|
|
249
|
-
result = api_instance.
|
|
338
|
+
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
339
|
+
result = api_instance.get_api_keys_by_id_api_keys_stats(company_id, api_key_id)
|
|
250
340
|
p result
|
|
251
341
|
rescue SparteraApiSdk::ApiError => e
|
|
252
|
-
puts "Error when calling APIKeysApi->
|
|
342
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_api_keys_stats: #{e}"
|
|
253
343
|
end
|
|
254
344
|
```
|
|
255
345
|
|
|
256
|
-
#### Using the
|
|
346
|
+
#### Using the get_api_keys_by_id_api_keys_stats_with_http_info variant
|
|
257
347
|
|
|
258
348
|
This returns an Array which contains the response data, status code and headers.
|
|
259
349
|
|
|
260
|
-
> <Array(<
|
|
350
|
+
> <Array(<GetApiKeysById200Response>, Integer, Hash)> get_api_keys_by_id_api_keys_stats_with_http_info(company_id, api_key_id)
|
|
261
351
|
|
|
262
352
|
```ruby
|
|
263
353
|
begin
|
|
264
|
-
#
|
|
265
|
-
data, status_code, headers = api_instance.
|
|
354
|
+
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
355
|
+
data, status_code, headers = api_instance.get_api_keys_by_id_api_keys_stats_with_http_info(company_id, api_key_id)
|
|
266
356
|
p status_code # => 2xx
|
|
267
357
|
p headers # => { ... }
|
|
268
|
-
p data # => <
|
|
358
|
+
p data # => <GetApiKeysById200Response>
|
|
269
359
|
rescue SparteraApiSdk::ApiError => e
|
|
270
|
-
puts "Error when calling APIKeysApi->
|
|
360
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_api_keys_stats_with_http_info: #{e}"
|
|
271
361
|
end
|
|
272
362
|
```
|
|
273
363
|
|
|
@@ -275,11 +365,12 @@ end
|
|
|
275
365
|
|
|
276
366
|
| Name | Type | Description | Notes |
|
|
277
367
|
| ---- | ---- | ----------- | ----- |
|
|
278
|
-
| **company_id** | **String** |
|
|
368
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
369
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
279
370
|
|
|
280
371
|
### Return type
|
|
281
372
|
|
|
282
|
-
[**
|
|
373
|
+
[**GetApiKeysById200Response**](GetApiKeysById200Response.md)
|
|
283
374
|
|
|
284
375
|
### Authorization
|
|
285
376
|
|
|
@@ -291,11 +382,11 @@ end
|
|
|
291
382
|
- **Accept**: application/json
|
|
292
383
|
|
|
293
384
|
|
|
294
|
-
##
|
|
385
|
+
## list_api_keys
|
|
295
386
|
|
|
296
|
-
> <
|
|
387
|
+
> <ListApiKeys200Response> list_api_keys(company_id, opts)
|
|
297
388
|
|
|
298
|
-
|
|
389
|
+
Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
299
390
|
|
|
300
391
|
### Examples
|
|
301
392
|
|
|
@@ -311,33 +402,39 @@ SparteraApiSdk.configure do |config|
|
|
|
311
402
|
end
|
|
312
403
|
|
|
313
404
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
314
|
-
company_id = 'company_id_example' # String |
|
|
315
|
-
|
|
405
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
406
|
+
opts = {
|
|
407
|
+
page: 56, # Integer | Page number for pagination
|
|
408
|
+
limit: 56, # Integer | Number of items per page
|
|
409
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
410
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
411
|
+
search: 'search_example' # String | Search term to filter results
|
|
412
|
+
}
|
|
316
413
|
|
|
317
414
|
begin
|
|
318
|
-
#
|
|
319
|
-
result = api_instance.
|
|
415
|
+
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
416
|
+
result = api_instance.list_api_keys(company_id, opts)
|
|
320
417
|
p result
|
|
321
418
|
rescue SparteraApiSdk::ApiError => e
|
|
322
|
-
puts "Error when calling APIKeysApi->
|
|
419
|
+
puts "Error when calling APIKeysApi->list_api_keys: #{e}"
|
|
323
420
|
end
|
|
324
421
|
```
|
|
325
422
|
|
|
326
|
-
#### Using the
|
|
423
|
+
#### Using the list_api_keys_with_http_info variant
|
|
327
424
|
|
|
328
425
|
This returns an Array which contains the response data, status code and headers.
|
|
329
426
|
|
|
330
|
-
> <Array(<
|
|
427
|
+
> <Array(<ListApiKeys200Response>, Integer, Hash)> list_api_keys_with_http_info(company_id, opts)
|
|
331
428
|
|
|
332
429
|
```ruby
|
|
333
430
|
begin
|
|
334
|
-
#
|
|
335
|
-
data, status_code, headers = api_instance.
|
|
431
|
+
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
432
|
+
data, status_code, headers = api_instance.list_api_keys_with_http_info(company_id, opts)
|
|
336
433
|
p status_code # => 2xx
|
|
337
434
|
p headers # => { ... }
|
|
338
|
-
p data # => <
|
|
435
|
+
p data # => <ListApiKeys200Response>
|
|
339
436
|
rescue SparteraApiSdk::ApiError => e
|
|
340
|
-
puts "Error when calling APIKeysApi->
|
|
437
|
+
puts "Error when calling APIKeysApi->list_api_keys_with_http_info: #{e}"
|
|
341
438
|
end
|
|
342
439
|
```
|
|
343
440
|
|
|
@@ -345,12 +442,16 @@ end
|
|
|
345
442
|
|
|
346
443
|
| Name | Type | Description | Notes |
|
|
347
444
|
| ---- | ---- | ----------- | ----- |
|
|
348
|
-
| **company_id** | **String** |
|
|
349
|
-
| **
|
|
445
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
446
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
447
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
448
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
449
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
450
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
350
451
|
|
|
351
452
|
### Return type
|
|
352
453
|
|
|
353
|
-
[**
|
|
454
|
+
[**ListApiKeys200Response**](ListApiKeys200Response.md)
|
|
354
455
|
|
|
355
456
|
### Authorization
|
|
356
457
|
|
|
@@ -361,3 +462,76 @@ end
|
|
|
361
462
|
- **Content-Type**: Not defined
|
|
362
463
|
- **Accept**: application/json
|
|
363
464
|
|
|
465
|
+
|
|
466
|
+
## update_api_keys
|
|
467
|
+
|
|
468
|
+
> <UpdateApiKeys200Response> update_api_keys(company_id, api_key_id, api_keys_update)
|
|
469
|
+
|
|
470
|
+
Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
471
|
+
|
|
472
|
+
### Examples
|
|
473
|
+
|
|
474
|
+
```ruby
|
|
475
|
+
require 'time'
|
|
476
|
+
require 'spartera_api_sdk'
|
|
477
|
+
# setup authorization
|
|
478
|
+
SparteraApiSdk.configure do |config|
|
|
479
|
+
# Configure API key authorization: ApiKeyAuth
|
|
480
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
481
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
482
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
486
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
487
|
+
api_key_id = 'api_key_id_example' # String | Unique identifier for the Api Key
|
|
488
|
+
api_keys_update = SparteraApiSdk::ApiKeysUpdate.new # ApiKeysUpdate |
|
|
489
|
+
|
|
490
|
+
begin
|
|
491
|
+
# Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
492
|
+
result = api_instance.update_api_keys(company_id, api_key_id, api_keys_update)
|
|
493
|
+
p result
|
|
494
|
+
rescue SparteraApiSdk::ApiError => e
|
|
495
|
+
puts "Error when calling APIKeysApi->update_api_keys: #{e}"
|
|
496
|
+
end
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
#### Using the update_api_keys_with_http_info variant
|
|
500
|
+
|
|
501
|
+
This returns an Array which contains the response data, status code and headers.
|
|
502
|
+
|
|
503
|
+
> <Array(<UpdateApiKeys200Response>, Integer, Hash)> update_api_keys_with_http_info(company_id, api_key_id, api_keys_update)
|
|
504
|
+
|
|
505
|
+
```ruby
|
|
506
|
+
begin
|
|
507
|
+
# Update an existing API key by ID. Can update metadata like name, expiration, rate limits, etc. Cannot update the actual key value (for security).
|
|
508
|
+
data, status_code, headers = api_instance.update_api_keys_with_http_info(company_id, api_key_id, api_keys_update)
|
|
509
|
+
p status_code # => 2xx
|
|
510
|
+
p headers # => { ... }
|
|
511
|
+
p data # => <UpdateApiKeys200Response>
|
|
512
|
+
rescue SparteraApiSdk::ApiError => e
|
|
513
|
+
puts "Error when calling APIKeysApi->update_api_keys_with_http_info: #{e}"
|
|
514
|
+
end
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### Parameters
|
|
518
|
+
|
|
519
|
+
| Name | Type | Description | Notes |
|
|
520
|
+
| ---- | ---- | ----------- | ----- |
|
|
521
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
522
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
523
|
+
| **api_keys_update** | [**ApiKeysUpdate**](ApiKeysUpdate.md) | | |
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
[**UpdateApiKeys200Response**](UpdateApiKeys200Response.md)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: application/json
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
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. | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | Optional. | [optional] |
|
|
9
|
+
| **alert_id** | **Integer** | Auto-generated unique identifier. | [optional] |
|
|
10
|
+
| **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. | |
|
|
11
|
+
| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
|
|
12
|
+
| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | |
|
|
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: 2025-04-01T00:00:00Z,
|
|
22
|
+
last_updated: 2025-04-01T00:00:00Z,
|
|
23
|
+
alert_id: 1,
|
|
24
|
+
asset_id: asset_id_abc123,
|
|
25
|
+
user_id: user_id_abc123,
|
|
26
|
+
company_id: company_id_abc123,
|
|
27
|
+
is_active: true
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|