spartera_api_sdk 1.0.77 → 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 +150 -126
- data/docs/Alerts.md +13 -13
- data/docs/AlertsApi.md +139 -139
- data/docs/AlertsInput.md +7 -7
- data/docs/AlertsUpdate.md +7 -7
- data/docs/ApiKeys.md +19 -11
- data/docs/ApiKeysInput.md +13 -5
- data/docs/ApiKeysUpdate.md +13 -5
- data/docs/AssetPriceHistory.md +14 -12
- data/docs/AssetPriceHistoryApi.md +164 -164
- data/docs/AssetPriceHistoryInput.md +8 -6
- data/docs/AssetPriceHistoryUpdate.md +8 -6
- data/docs/AssetUsecases.md +28 -0
- data/docs/AssetUsecasesApi.md +157 -0
- data/docs/Assets.md +113 -83
- data/docs/AssetsApi.md +534 -206
- data/docs/AssetsInput.md +100 -70
- data/docs/AssetsUpdate.md +100 -70
- data/docs/CloudProviders.md +12 -12
- data/docs/CloudProvidersApi.md +44 -31
- data/docs/CloudProvidersInput.md +6 -6
- data/docs/CloudProvidersUpdate.md +6 -6
- data/docs/Companies.md +27 -23
- data/docs/CompaniesApi.md +313 -147
- data/docs/CompaniesInput.md +21 -17
- data/docs/CompaniesUpdate.md +21 -17
- data/docs/Connections.md +22 -22
- data/docs/ConnectionsApi.md +149 -125
- data/docs/ConnectionsInput.md +16 -16
- data/docs/ConnectionsUpdate.md +16 -16
- data/docs/CreateAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md → CreateAlerts200ResponseData.md} +2 -2
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/{CompaniesCompanyIdApiKeysPost200ResponseData.md → CreateApiKeys200ResponseData.md} +2 -2
- data/docs/{CompaniesCompanyIdPatch200Response.md → CreateAssetPriceHistory200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesPost200ResponseData.md → CreateAssetPriceHistory200ResponseData.md} +2 -2
- 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/CreatePosts200Response.md +20 -0
- 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/{CompaniesCompanyIdApiKeysApiKeyIdDelete200ResponseData.md → DeleteApiKeys200ResponseData.md} +2 -2
- data/docs/DeleteAssetPriceHistory200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200ResponseData.md → DeleteAssetPriceHistory200ResponseData.md} +2 -2
- 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 +15 -15
- data/docs/FavoritesApi.md +159 -159
- data/docs/FavoritesInput.md +9 -9
- data/docs/FavoritesUpdate.md +9 -9
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response.md → GetAlertsById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdApiKeysApiKeyIdGet200Response.md → GetApiKeysById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response.md → GetAssetPriceHistoryById200Response.md} +2 -2
- data/docs/GetAssetUsecasesById200Response.md +20 -0
- data/docs/{AnalyzeCompanyHandleAssetsAssetSlugGet200Response.md → GetAssetsByIdAnalyze200Response.md} +2 -2
- data/docs/{CloudProvidersProviderIdGet200Response.md → GetCloudProvidersById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdGet200Response.md → GetCompaniesById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → GetConnectionsById200Response.md} +2 -2
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response.md → GetFavoritesById200Response.md} +2 -2
- data/docs/GetIndustriesById200Response.md +20 -0
- data/docs/{JobFunctionsFunctionIdGet200Response.md → GetJobFunctionsById200Response.md} +2 -2
- data/docs/GetPostgenIntegrationsById200Response.md +20 -0
- data/docs/GetPostsById200Response.md +20 -0
- data/docs/GetStorageEnginesById200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetUsersById200Response.md} +2 -2
- 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 +8 -8
- data/docs/JobFunctionsApi.md +38 -25
- data/docs/JobFunctionsInput.md +2 -2
- data/docs/JobFunctionsUpdate.md +2 -2
- data/docs/{CompaniesCompanyIdApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
- data/docs/ListAssetUsecases200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsGet200Response.md → ListAssets200Response.md} +2 -2
- data/docs/{CloudProvidersGet200Response.md → ListCloudProviders200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdAnalyticsAssetsGet200Response.md → ListCompaniesAnalyticsAssets200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdConnectionsGet200Response.md → ListConnections200Response.md} +2 -2
- data/docs/ListEndpoints200Response.md +20 -0
- data/docs/ListIndustries200Response.md +20 -0
- data/docs/{JobFunctionsGet200Response.md → ListJobFunctions200Response.md} +2 -2
- data/docs/ListPostgenIntegrations200Response.md +20 -0
- data/docs/ListPosts200Response.md +20 -0
- data/docs/ListStorageEngines200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersGet200Response.md → ListUsers200Response.md} +2 -2
- 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/{CompaniesCompanyIdApiKeysApiKeyIdPatch200ResponseData.md → UpdateApiKeys200ResponseData.md} +2 -2
- data/docs/UpdateAssetPriceHistory200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200ResponseData.md → UpdateAssetPriceHistory200ResponseData.md} +2 -2
- data/docs/UpdateAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md → UpdateAssets200ResponseData.md} +2 -2
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/{CompaniesCompanyIdPatch200ResponseData.md → UpdateCompanies200ResponseData.md} +2 -2
- 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 +20 -16
- data/docs/UsersApi.md +302 -97
- data/docs/UsersInput.md +14 -10
- data/docs/UsersUpdate.md +14 -10
- 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 +386 -152
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +454 -207
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +949 -225
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +83 -31
- data/lib/spartera_api_sdk/api/companies_api.rb +651 -148
- 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 +75 -23
- 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 +574 -105
- 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/alerts.rb +10 -77
- data/lib/spartera_api_sdk/models/alerts_input.rb +6 -76
- data/lib/spartera_api_sdk/models/alerts_update.rb +6 -76
- data/lib/spartera_api_sdk/models/api_keys.rb +82 -78
- data/lib/spartera_api_sdk/models/api_keys_input.rb +44 -77
- data/lib/spartera_api_sdk/models/api_keys_update.rb +44 -77
- data/lib/spartera_api_sdk/models/asset_price_history.rb +21 -96
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +17 -95
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +17 -78
- data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
- data/lib/spartera_api_sdk/models/assets.rb +262 -93
- data/lib/spartera_api_sdk/models/assets_input.rb +238 -91
- data/lib/spartera_api_sdk/models/assets_update.rb +238 -91
- data/lib/spartera_api_sdk/models/cloud_providers.rb +10 -77
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +6 -76
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +6 -76
- data/lib/spartera_api_sdk/models/companies.rb +72 -81
- data/lib/spartera_api_sdk/models/companies_input.rb +68 -80
- data/lib/spartera_api_sdk/models/companies_update.rb +68 -80
- data/lib/spartera_api_sdk/models/connections.rb +15 -78
- data/lib/spartera_api_sdk/models/connections_input.rb +11 -77
- data/lib/spartera_api_sdk/models/connections_update.rb +11 -77
- data/lib/spartera_api_sdk/models/{cloud_providers_provider_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/create_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_post200_response_data.rb → create_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_patch200_response.rb → create_asset_price_history200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_post200_response_data.rb → create_asset_price_history200_response_data.rb} +5 -78
- 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/{job_functions_function_id_get200_response.rb → create_postgen_integrations200_response.rb} +6 -79
- 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/{companies_company_id_api_keys_api_key_id_delete200_response_data.rb → delete_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data.rb → delete_asset_price_history200_response_data.rb} +5 -78
- 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/favorites.rb +10 -77
- data/lib/spartera_api_sdk/models/favorites_input.rb +6 -76
- data/lib/spartera_api_sdk/models/favorites_update.rb +6 -76
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_api_key_id_get200_response.rb → get_api_keys_by_id200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_get200_response.rb → get_asset_price_history_by_id200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{analyze_company_handle_assets_asset_slug_get200_response.rb → get_assets_by_id_analyze200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_get200_response.rb → get_cloud_providers_by_id200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_get200_response.rb → get_connections_by_id200_response.rb} +5 -78
- 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/{companies_company_id_users_user_id_get200_response.rb → get_users_by_id200_response.rb} +5 -78
- 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/{cloud_providers_provider_id_storage_engines_get200_response.rb → inline_object6.rb} +22 -102
- data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
- data/lib/spartera_api_sdk/models/job_functions.rb +8 -77
- data/lib/spartera_api_sdk/models/job_functions_input.rb +4 -76
- data/lib/spartera_api_sdk/models/job_functions_update.rb +4 -76
- data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{cloud_providers_get200_response.rb → list_asset_usecases200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_get200_response.rb → list_assets200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_get200_response.rb → list_companies_analytics_assets200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{job_functions_get200_response.rb → list_connections200_response.rb} +6 -79
- 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/{companies_company_id_api_keys_api_key_id_patch200_response_data.rb → update_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data.rb → update_asset_price_history200_response_data.rb} +5 -78
- 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/{companies_company_id_patch200_response_data.rb → update_companies200_response_data.rb} +5 -78
- 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/users.rb +70 -82
- data/lib/spartera_api_sdk/models/users_input.rb +32 -81
- data/lib/spartera_api_sdk/models/users_update.rb +32 -81
- data/lib/spartera_api_sdk/version.rb +13 -1
- data/lib/spartera_api_sdk.rb +118 -67
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +50 -50
- data/spec/api/api_keys_api_spec.rb +53 -43
- data/spec/api/asset_price_history_api_spec.rb +57 -57
- 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 -48
- 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 +14 -9
- 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 +81 -32
- data/spec/models/alerts_input_spec.rb +3 -3
- data/spec/models/alerts_spec.rb +3 -3
- data/spec/models/alerts_update_spec.rb +3 -3
- data/spec/models/api_keys_input_spec.rb +27 -3
- data/spec/models/api_keys_spec.rb +27 -3
- data/spec/models/api_keys_update_spec.rb +27 -3
- data/spec/models/asset_price_history_input_spec.rb +9 -3
- data/spec/models/asset_price_history_spec.rb +9 -3
- data/spec/models/asset_price_history_update_spec.rb +9 -3
- data/spec/models/asset_usecases_spec.rb +66 -0
- data/spec/models/assets_input_spec.rb +110 -4
- data/spec/models/assets_spec.rb +110 -4
- data/spec/models/assets_update_spec.rb +110 -4
- data/spec/models/cloud_providers_input_spec.rb +3 -3
- data/spec/models/cloud_providers_spec.rb +3 -3
- data/spec/models/cloud_providers_update_spec.rb +3 -3
- data/spec/models/companies_input_spec.rb +19 -3
- data/spec/models/companies_spec.rb +19 -3
- data/spec/models/companies_update_spec.rb +19 -3
- data/spec/models/connections_input_spec.rb +3 -3
- data/spec/models/connections_spec.rb +3 -3
- data/spec/models/connections_update_spec.rb +3 -3
- data/spec/models/create_alerts200_response_data_spec.rb +36 -0
- data/spec/models/create_alerts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_api_keys_post200_response_data_spec.rb → create_api_keys200_response_data_spec.rb} +8 -8
- 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_patch200_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/create_assets_analyze200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_connections_post200_response_data_spec.rb → create_connections200_response_data_spec.rb} +8 -8
- data/spec/models/{cloud_providers_get200_response_spec.rb → create_connections200_response_spec.rb} +8 -8
- 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/{job_functions_function_id_get200_response_spec.rb → create_postgen_integrations200_response_spec.rb} +8 -8
- 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 +3 -3
- data/spec/models/favorites_spec.rb +3 -3
- data/spec/models/favorites_update_spec.rb +3 -3
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/{job_functions_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/{companies_company_id_get200_response_spec.rb → get_cloud_providers_by_id200_response_spec.rb} +8 -8
- 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/{cloud_providers_provider_id_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 +3 -3
- data/spec/models/job_functions_spec.rb +3 -3
- data/spec/models/job_functions_update_spec.rb +3 -3
- 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/postgen_integrations_spec.rb +90 -0
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/posts_input_spec.rb +168 -0
- data/spec/models/posts_spec.rb +186 -0
- data/spec/models/posts_update_spec.rb +168 -0
- data/spec/models/storage_engines_spec.rb +82 -0
- data/spec/models/update_alerts200_response_data_spec.rb +36 -0
- data/spec/models/update_alerts200_response_spec.rb +42 -0
- data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/update_api_keys200_response_spec.rb +42 -0
- data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/update_assets200_response_data_spec.rb +36 -0
- data/spec/models/update_assets200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_patch200_response_data_spec.rb → update_companies200_response_data_spec.rb} +8 -8
- 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 +15 -3
- data/spec/models/users_spec.rb +15 -3
- data/spec/models/users_update_spec.rb +15 -3
- data/spec/spec_helper.rb +111 -0
- metadata +515 -337
- data/docs/CloudProvidersProviderIdStorageEnginesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesPost200Response.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/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/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +0 -20
- data/lib/spartera_api_sdk/models/companies_company_id_analytics_assets_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_post200_response.rb +0 -264
- 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_assets_asset_id_prices_aph_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_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_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +0 -266
- 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_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_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_asset_asset_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +0 -266
- 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_category_category_get200_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_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/spec/models/analyze_company_handle_assets_asset_slug_get200_response_spec.rb +0 -42
- data/spec/models/cloud_providers_provider_id_storage_engines_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_analytics_assets_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_post200_response_spec.rb +0 -42
- 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_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_post200_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_get200_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_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_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_asset_asset_id_get200_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_category_category_get200_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_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/Rakefile
ADDED
data/docs/APIKeysApi.md
CHANGED
|
@@ -4,20 +4,20 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
7
|
+
| [**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). |
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## create_api_keys
|
|
17
17
|
|
|
18
|
-
> <
|
|
18
|
+
> <CreateApiKeys200Response> create_api_keys(company_id, api_keys_input, opts)
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -33,33 +33,40 @@ SparteraApiSdk.configure do |config|
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
36
|
-
company_id = 'company_id_example' # String |
|
|
37
|
-
|
|
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
|
+
}
|
|
38
45
|
|
|
39
46
|
begin
|
|
40
|
-
#
|
|
41
|
-
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)
|
|
42
49
|
p result
|
|
43
50
|
rescue SparteraApiSdk::ApiError => e
|
|
44
|
-
puts "Error when calling APIKeysApi->
|
|
51
|
+
puts "Error when calling APIKeysApi->create_api_keys: #{e}"
|
|
45
52
|
end
|
|
46
53
|
```
|
|
47
54
|
|
|
48
|
-
#### Using the
|
|
55
|
+
#### Using the create_api_keys_with_http_info variant
|
|
49
56
|
|
|
50
57
|
This returns an Array which contains the response data, status code and headers.
|
|
51
58
|
|
|
52
|
-
> <Array(<
|
|
59
|
+
> <Array(<CreateApiKeys200Response>, Integer, Hash)> create_api_keys_with_http_info(company_id, api_keys_input, opts)
|
|
53
60
|
|
|
54
61
|
```ruby
|
|
55
62
|
begin
|
|
56
|
-
#
|
|
57
|
-
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)
|
|
58
65
|
p status_code # => 2xx
|
|
59
66
|
p headers # => { ... }
|
|
60
|
-
p data # => <
|
|
67
|
+
p data # => <CreateApiKeys200Response>
|
|
61
68
|
rescue SparteraApiSdk::ApiError => e
|
|
62
|
-
puts "Error when calling APIKeysApi->
|
|
69
|
+
puts "Error when calling APIKeysApi->create_api_keys_with_http_info: #{e}"
|
|
63
70
|
end
|
|
64
71
|
```
|
|
65
72
|
|
|
@@ -67,12 +74,17 @@ end
|
|
|
67
74
|
|
|
68
75
|
| Name | Type | Description | Notes |
|
|
69
76
|
| ---- | ---- | ----------- | ----- |
|
|
70
|
-
| **company_id** | **String** |
|
|
71
|
-
| **
|
|
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] |
|
|
72
84
|
|
|
73
85
|
### Return type
|
|
74
86
|
|
|
75
|
-
[**
|
|
87
|
+
[**CreateApiKeys200Response**](CreateApiKeys200Response.md)
|
|
76
88
|
|
|
77
89
|
### Authorization
|
|
78
90
|
|
|
@@ -80,15 +92,15 @@ end
|
|
|
80
92
|
|
|
81
93
|
### HTTP request headers
|
|
82
94
|
|
|
83
|
-
- **Content-Type**:
|
|
95
|
+
- **Content-Type**: application/json
|
|
84
96
|
- **Accept**: application/json
|
|
85
97
|
|
|
86
98
|
|
|
87
|
-
##
|
|
99
|
+
## create_api_keys_api_keys_revoke
|
|
88
100
|
|
|
89
|
-
> <
|
|
101
|
+
> <CreateApiKeys200Response> create_api_keys_api_keys_revoke(company_id, api_key_id, api_keys_input)
|
|
90
102
|
|
|
91
|
-
|
|
103
|
+
Explicitly revoke an API key with reason tracking. This is different from delete as it includes revocation metadata.
|
|
92
104
|
|
|
93
105
|
### Examples
|
|
94
106
|
|
|
@@ -104,33 +116,34 @@ SparteraApiSdk.configure do |config|
|
|
|
104
116
|
end
|
|
105
117
|
|
|
106
118
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
107
|
-
company_id = 'company_id_example' # String |
|
|
108
|
-
api_key_id = 'api_key_id_example' # String |
|
|
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 |
|
|
109
122
|
|
|
110
123
|
begin
|
|
111
|
-
#
|
|
112
|
-
result = api_instance.
|
|
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)
|
|
113
126
|
p result
|
|
114
127
|
rescue SparteraApiSdk::ApiError => e
|
|
115
|
-
puts "Error when calling APIKeysApi->
|
|
128
|
+
puts "Error when calling APIKeysApi->create_api_keys_api_keys_revoke: #{e}"
|
|
116
129
|
end
|
|
117
130
|
```
|
|
118
131
|
|
|
119
|
-
#### Using the
|
|
132
|
+
#### Using the create_api_keys_api_keys_revoke_with_http_info variant
|
|
120
133
|
|
|
121
134
|
This returns an Array which contains the response data, status code and headers.
|
|
122
135
|
|
|
123
|
-
> <Array(<
|
|
136
|
+
> <Array(<CreateApiKeys200Response>, Integer, Hash)> create_api_keys_api_keys_revoke_with_http_info(company_id, api_key_id, api_keys_input)
|
|
124
137
|
|
|
125
138
|
```ruby
|
|
126
139
|
begin
|
|
127
|
-
#
|
|
128
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
129
142
|
p status_code # => 2xx
|
|
130
143
|
p headers # => { ... }
|
|
131
|
-
p data # => <
|
|
144
|
+
p data # => <CreateApiKeys200Response>
|
|
132
145
|
rescue SparteraApiSdk::ApiError => e
|
|
133
|
-
puts "Error when calling APIKeysApi->
|
|
146
|
+
puts "Error when calling APIKeysApi->create_api_keys_api_keys_revoke_with_http_info: #{e}"
|
|
134
147
|
end
|
|
135
148
|
```
|
|
136
149
|
|
|
@@ -138,12 +151,13 @@ end
|
|
|
138
151
|
|
|
139
152
|
| Name | Type | Description | Notes |
|
|
140
153
|
| ---- | ---- | ----------- | ----- |
|
|
141
|
-
| **company_id** | **String** |
|
|
142
|
-
| **api_key_id** | **String** |
|
|
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) | | |
|
|
143
157
|
|
|
144
158
|
### Return type
|
|
145
159
|
|
|
146
|
-
[**
|
|
160
|
+
[**CreateApiKeys200Response**](CreateApiKeys200Response.md)
|
|
147
161
|
|
|
148
162
|
### Authorization
|
|
149
163
|
|
|
@@ -151,15 +165,15 @@ end
|
|
|
151
165
|
|
|
152
166
|
### HTTP request headers
|
|
153
167
|
|
|
154
|
-
- **Content-Type**:
|
|
168
|
+
- **Content-Type**: application/json
|
|
155
169
|
- **Accept**: application/json
|
|
156
170
|
|
|
157
171
|
|
|
158
|
-
##
|
|
172
|
+
## delete_api_keys
|
|
159
173
|
|
|
160
|
-
> <
|
|
174
|
+
> <DeleteApiKeys200Response> delete_api_keys(company_id, api_key_id)
|
|
161
175
|
|
|
162
|
-
|
|
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.
|
|
163
177
|
|
|
164
178
|
### Examples
|
|
165
179
|
|
|
@@ -175,34 +189,33 @@ SparteraApiSdk.configure do |config|
|
|
|
175
189
|
end
|
|
176
190
|
|
|
177
191
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
178
|
-
company_id = 'company_id_example' # String |
|
|
179
|
-
api_key_id = 'api_key_id_example' # String |
|
|
180
|
-
api_keys_update = SparteraApiSdk::ApiKeysUpdate.new # ApiKeysUpdate |
|
|
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
|
|
181
194
|
|
|
182
195
|
begin
|
|
183
|
-
#
|
|
184
|
-
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)
|
|
185
198
|
p result
|
|
186
199
|
rescue SparteraApiSdk::ApiError => e
|
|
187
|
-
puts "Error when calling APIKeysApi->
|
|
200
|
+
puts "Error when calling APIKeysApi->delete_api_keys: #{e}"
|
|
188
201
|
end
|
|
189
202
|
```
|
|
190
203
|
|
|
191
|
-
#### Using the
|
|
204
|
+
#### Using the delete_api_keys_with_http_info variant
|
|
192
205
|
|
|
193
206
|
This returns an Array which contains the response data, status code and headers.
|
|
194
207
|
|
|
195
|
-
> <Array(<
|
|
208
|
+
> <Array(<DeleteApiKeys200Response>, Integer, Hash)> delete_api_keys_with_http_info(company_id, api_key_id)
|
|
196
209
|
|
|
197
210
|
```ruby
|
|
198
211
|
begin
|
|
199
|
-
#
|
|
200
|
-
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)
|
|
201
214
|
p status_code # => 2xx
|
|
202
215
|
p headers # => { ... }
|
|
203
|
-
p data # => <
|
|
216
|
+
p data # => <DeleteApiKeys200Response>
|
|
204
217
|
rescue SparteraApiSdk::ApiError => e
|
|
205
|
-
puts "Error when calling APIKeysApi->
|
|
218
|
+
puts "Error when calling APIKeysApi->delete_api_keys_with_http_info: #{e}"
|
|
206
219
|
end
|
|
207
220
|
```
|
|
208
221
|
|
|
@@ -210,13 +223,12 @@ end
|
|
|
210
223
|
|
|
211
224
|
| Name | Type | Description | Notes |
|
|
212
225
|
| ---- | ---- | ----------- | ----- |
|
|
213
|
-
| **company_id** | **String** |
|
|
214
|
-
| **api_key_id** | **String** |
|
|
215
|
-
| **api_keys_update** | [**ApiKeysUpdate**](ApiKeysUpdate.md) | | |
|
|
226
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
227
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
216
228
|
|
|
217
229
|
### Return type
|
|
218
230
|
|
|
219
|
-
[**
|
|
231
|
+
[**DeleteApiKeys200Response**](DeleteApiKeys200Response.md)
|
|
220
232
|
|
|
221
233
|
### Authorization
|
|
222
234
|
|
|
@@ -224,15 +236,15 @@ end
|
|
|
224
236
|
|
|
225
237
|
### HTTP request headers
|
|
226
238
|
|
|
227
|
-
- **Content-Type**:
|
|
239
|
+
- **Content-Type**: Not defined
|
|
228
240
|
- **Accept**: application/json
|
|
229
241
|
|
|
230
242
|
|
|
231
|
-
##
|
|
243
|
+
## get_api_keys_by_id
|
|
232
244
|
|
|
233
|
-
> <
|
|
245
|
+
> <GetApiKeysById200Response> get_api_keys_by_id(company_id, api_key_id)
|
|
234
246
|
|
|
235
|
-
|
|
247
|
+
Get single API key by ID. Returns masked API key for security (sk_****1234).
|
|
236
248
|
|
|
237
249
|
### Examples
|
|
238
250
|
|
|
@@ -248,34 +260,33 @@ SparteraApiSdk.configure do |config|
|
|
|
248
260
|
end
|
|
249
261
|
|
|
250
262
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
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 |
|
|
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
|
|
254
265
|
|
|
255
266
|
begin
|
|
256
|
-
#
|
|
257
|
-
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)
|
|
258
269
|
p result
|
|
259
270
|
rescue SparteraApiSdk::ApiError => e
|
|
260
|
-
puts "Error when calling APIKeysApi->
|
|
271
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id: #{e}"
|
|
261
272
|
end
|
|
262
273
|
```
|
|
263
274
|
|
|
264
|
-
#### Using the
|
|
275
|
+
#### Using the get_api_keys_by_id_with_http_info variant
|
|
265
276
|
|
|
266
277
|
This returns an Array which contains the response data, status code and headers.
|
|
267
278
|
|
|
268
|
-
> <Array(<
|
|
279
|
+
> <Array(<GetApiKeysById200Response>, Integer, Hash)> get_api_keys_by_id_with_http_info(company_id, api_key_id)
|
|
269
280
|
|
|
270
281
|
```ruby
|
|
271
282
|
begin
|
|
272
|
-
#
|
|
273
|
-
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)
|
|
274
285
|
p status_code # => 2xx
|
|
275
286
|
p headers # => { ... }
|
|
276
|
-
p data # => <
|
|
287
|
+
p data # => <GetApiKeysById200Response>
|
|
277
288
|
rescue SparteraApiSdk::ApiError => e
|
|
278
|
-
puts "Error when calling APIKeysApi->
|
|
289
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_with_http_info: #{e}"
|
|
279
290
|
end
|
|
280
291
|
```
|
|
281
292
|
|
|
@@ -283,13 +294,12 @@ end
|
|
|
283
294
|
|
|
284
295
|
| Name | Type | Description | Notes |
|
|
285
296
|
| ---- | ---- | ----------- | ----- |
|
|
286
|
-
| **company_id** | **String** |
|
|
287
|
-
| **api_key_id** | **String** |
|
|
288
|
-
| **api_keys_input** | [**ApiKeysInput**](ApiKeysInput.md) | | |
|
|
297
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
298
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
289
299
|
|
|
290
300
|
### Return type
|
|
291
301
|
|
|
292
|
-
[**
|
|
302
|
+
[**GetApiKeysById200Response**](GetApiKeysById200Response.md)
|
|
293
303
|
|
|
294
304
|
### Authorization
|
|
295
305
|
|
|
@@ -297,13 +307,13 @@ end
|
|
|
297
307
|
|
|
298
308
|
### HTTP request headers
|
|
299
309
|
|
|
300
|
-
- **Content-Type**:
|
|
310
|
+
- **Content-Type**: Not defined
|
|
301
311
|
- **Accept**: application/json
|
|
302
312
|
|
|
303
313
|
|
|
304
|
-
##
|
|
314
|
+
## get_api_keys_by_id_api_keys_stats
|
|
305
315
|
|
|
306
|
-
> <
|
|
316
|
+
> <GetApiKeysById200Response> get_api_keys_by_id_api_keys_stats(company_id, api_key_id)
|
|
307
317
|
|
|
308
318
|
Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
309
319
|
|
|
@@ -321,33 +331,33 @@ SparteraApiSdk.configure do |config|
|
|
|
321
331
|
end
|
|
322
332
|
|
|
323
333
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
324
|
-
company_id = 'company_id_example' # String |
|
|
325
|
-
api_key_id = 'api_key_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
|
|
326
336
|
|
|
327
337
|
begin
|
|
328
338
|
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
329
|
-
result = api_instance.
|
|
339
|
+
result = api_instance.get_api_keys_by_id_api_keys_stats(company_id, api_key_id)
|
|
330
340
|
p result
|
|
331
341
|
rescue SparteraApiSdk::ApiError => e
|
|
332
|
-
puts "Error when calling APIKeysApi->
|
|
342
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_api_keys_stats: #{e}"
|
|
333
343
|
end
|
|
334
344
|
```
|
|
335
345
|
|
|
336
|
-
#### Using the
|
|
346
|
+
#### Using the get_api_keys_by_id_api_keys_stats_with_http_info variant
|
|
337
347
|
|
|
338
348
|
This returns an Array which contains the response data, status code and headers.
|
|
339
349
|
|
|
340
|
-
> <Array(<
|
|
350
|
+
> <Array(<GetApiKeysById200Response>, Integer, Hash)> get_api_keys_by_id_api_keys_stats_with_http_info(company_id, api_key_id)
|
|
341
351
|
|
|
342
352
|
```ruby
|
|
343
353
|
begin
|
|
344
354
|
# Get usage statistics for a specific API key. Returns usage count, last used date, failed attempts, etc.
|
|
345
|
-
data, status_code, headers = api_instance.
|
|
355
|
+
data, status_code, headers = api_instance.get_api_keys_by_id_api_keys_stats_with_http_info(company_id, api_key_id)
|
|
346
356
|
p status_code # => 2xx
|
|
347
357
|
p headers # => { ... }
|
|
348
|
-
p data # => <
|
|
358
|
+
p data # => <GetApiKeysById200Response>
|
|
349
359
|
rescue SparteraApiSdk::ApiError => e
|
|
350
|
-
puts "Error when calling APIKeysApi->
|
|
360
|
+
puts "Error when calling APIKeysApi->get_api_keys_by_id_api_keys_stats_with_http_info: #{e}"
|
|
351
361
|
end
|
|
352
362
|
```
|
|
353
363
|
|
|
@@ -355,12 +365,12 @@ end
|
|
|
355
365
|
|
|
356
366
|
| Name | Type | Description | Notes |
|
|
357
367
|
| ---- | ---- | ----------- | ----- |
|
|
358
|
-
| **company_id** | **String** |
|
|
359
|
-
| **api_key_id** | **String** |
|
|
368
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
369
|
+
| **api_key_id** | **String** | Unique identifier for the Api Key | |
|
|
360
370
|
|
|
361
371
|
### Return type
|
|
362
372
|
|
|
363
|
-
[**
|
|
373
|
+
[**GetApiKeysById200Response**](GetApiKeysById200Response.md)
|
|
364
374
|
|
|
365
375
|
### Authorization
|
|
366
376
|
|
|
@@ -372,9 +382,9 @@ end
|
|
|
372
382
|
- **Accept**: application/json
|
|
373
383
|
|
|
374
384
|
|
|
375
|
-
##
|
|
385
|
+
## list_api_keys
|
|
376
386
|
|
|
377
|
-
> <
|
|
387
|
+
> <ListApiKeys200Response> list_api_keys(company_id, opts)
|
|
378
388
|
|
|
379
389
|
Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
380
390
|
|
|
@@ -392,32 +402,39 @@ SparteraApiSdk.configure do |config|
|
|
|
392
402
|
end
|
|
393
403
|
|
|
394
404
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
395
|
-
company_id = 'company_id_example' # String |
|
|
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
|
+
}
|
|
396
413
|
|
|
397
414
|
begin
|
|
398
415
|
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
399
|
-
result = api_instance.
|
|
416
|
+
result = api_instance.list_api_keys(company_id, opts)
|
|
400
417
|
p result
|
|
401
418
|
rescue SparteraApiSdk::ApiError => e
|
|
402
|
-
puts "Error when calling APIKeysApi->
|
|
419
|
+
puts "Error when calling APIKeysApi->list_api_keys: #{e}"
|
|
403
420
|
end
|
|
404
421
|
```
|
|
405
422
|
|
|
406
|
-
#### Using the
|
|
423
|
+
#### Using the list_api_keys_with_http_info variant
|
|
407
424
|
|
|
408
425
|
This returns an Array which contains the response data, status code and headers.
|
|
409
426
|
|
|
410
|
-
> <Array(<
|
|
427
|
+
> <Array(<ListApiKeys200Response>, Integer, Hash)> list_api_keys_with_http_info(company_id, opts)
|
|
411
428
|
|
|
412
429
|
```ruby
|
|
413
430
|
begin
|
|
414
431
|
# Get all API keys for a company. Returns masked API keys for security (sk_****1234).
|
|
415
|
-
data, status_code, headers = api_instance.
|
|
432
|
+
data, status_code, headers = api_instance.list_api_keys_with_http_info(company_id, opts)
|
|
416
433
|
p status_code # => 2xx
|
|
417
434
|
p headers # => { ... }
|
|
418
|
-
p data # => <
|
|
435
|
+
p data # => <ListApiKeys200Response>
|
|
419
436
|
rescue SparteraApiSdk::ApiError => e
|
|
420
|
-
puts "Error when calling APIKeysApi->
|
|
437
|
+
puts "Error when calling APIKeysApi->list_api_keys_with_http_info: #{e}"
|
|
421
438
|
end
|
|
422
439
|
```
|
|
423
440
|
|
|
@@ -425,11 +442,16 @@ end
|
|
|
425
442
|
|
|
426
443
|
| Name | Type | Description | Notes |
|
|
427
444
|
| ---- | ---- | ----------- | ----- |
|
|
428
|
-
| **company_id** | **String** |
|
|
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] |
|
|
429
451
|
|
|
430
452
|
### Return type
|
|
431
453
|
|
|
432
|
-
[**
|
|
454
|
+
[**ListApiKeys200Response**](ListApiKeys200Response.md)
|
|
433
455
|
|
|
434
456
|
### Authorization
|
|
435
457
|
|
|
@@ -441,11 +463,11 @@ end
|
|
|
441
463
|
- **Accept**: application/json
|
|
442
464
|
|
|
443
465
|
|
|
444
|
-
##
|
|
466
|
+
## update_api_keys
|
|
445
467
|
|
|
446
|
-
> <
|
|
468
|
+
> <UpdateApiKeys200Response> update_api_keys(company_id, api_key_id, api_keys_update)
|
|
447
469
|
|
|
448
|
-
|
|
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).
|
|
449
471
|
|
|
450
472
|
### Examples
|
|
451
473
|
|
|
@@ -461,33 +483,34 @@ SparteraApiSdk.configure do |config|
|
|
|
461
483
|
end
|
|
462
484
|
|
|
463
485
|
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
464
|
-
company_id = 'company_id_example' # String |
|
|
465
|
-
|
|
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 |
|
|
466
489
|
|
|
467
490
|
begin
|
|
468
|
-
#
|
|
469
|
-
result = api_instance.
|
|
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)
|
|
470
493
|
p result
|
|
471
494
|
rescue SparteraApiSdk::ApiError => e
|
|
472
|
-
puts "Error when calling APIKeysApi->
|
|
495
|
+
puts "Error when calling APIKeysApi->update_api_keys: #{e}"
|
|
473
496
|
end
|
|
474
497
|
```
|
|
475
498
|
|
|
476
|
-
#### Using the
|
|
499
|
+
#### Using the update_api_keys_with_http_info variant
|
|
477
500
|
|
|
478
501
|
This returns an Array which contains the response data, status code and headers.
|
|
479
502
|
|
|
480
|
-
> <Array(<
|
|
503
|
+
> <Array(<UpdateApiKeys200Response>, Integer, Hash)> update_api_keys_with_http_info(company_id, api_key_id, api_keys_update)
|
|
481
504
|
|
|
482
505
|
```ruby
|
|
483
506
|
begin
|
|
484
|
-
#
|
|
485
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
486
509
|
p status_code # => 2xx
|
|
487
510
|
p headers # => { ... }
|
|
488
|
-
p data # => <
|
|
511
|
+
p data # => <UpdateApiKeys200Response>
|
|
489
512
|
rescue SparteraApiSdk::ApiError => e
|
|
490
|
-
puts "Error when calling APIKeysApi->
|
|
513
|
+
puts "Error when calling APIKeysApi->update_api_keys_with_http_info: #{e}"
|
|
491
514
|
end
|
|
492
515
|
```
|
|
493
516
|
|
|
@@ -495,12 +518,13 @@ end
|
|
|
495
518
|
|
|
496
519
|
| Name | Type | Description | Notes |
|
|
497
520
|
| ---- | ---- | ----------- | ----- |
|
|
498
|
-
| **company_id** | **String** |
|
|
499
|
-
| **
|
|
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) | | |
|
|
500
524
|
|
|
501
525
|
### Return type
|
|
502
526
|
|
|
503
|
-
[**
|
|
527
|
+
[**UpdateApiKeys200Response**](UpdateApiKeys200Response.md)
|
|
504
528
|
|
|
505
529
|
### Authorization
|
|
506
530
|
|
data/docs/Alerts.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **date_created** | **Time** |
|
|
8
|
-
| **last_updated** | **Time** |
|
|
9
|
-
| **alert_id** | **Integer** |
|
|
10
|
-
| **asset_id** | **String** |
|
|
11
|
-
| **user_id** | **String** |
|
|
12
|
-
| **company_id** | **String** |
|
|
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
13
|
| **is_active** | **Boolean** | Whether this alert is currently active | |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
@@ -18,13 +18,13 @@
|
|
|
18
18
|
require 'spartera_api_sdk'
|
|
19
19
|
|
|
20
20
|
instance = SparteraApiSdk::Alerts.new(
|
|
21
|
-
date_created:
|
|
22
|
-
last_updated:
|
|
23
|
-
alert_id:
|
|
24
|
-
asset_id:
|
|
25
|
-
user_id:
|
|
26
|
-
company_id:
|
|
27
|
-
is_active:
|
|
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
28
|
)
|
|
29
29
|
```
|
|
30
30
|
|