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/README.md
CHANGED
|
@@ -1,360 +1,369 @@
|
|
|
1
|
-
#
|
|
1
|
+
# spartera_api_sdk
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
The Ruby SDK for Spartera API provides a convenient way to interact with the Spartera platform from Ruby applications.
|
|
3
|
+
SparteraApiSdk - the Ruby gem for the Spartera API Documentation
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
Auto-generated API documentation for REST services of the Spartera platform
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
- Ruby 2.7 or higher
|
|
10
|
-
- Bundler
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
- API version: 1.25.0
|
|
10
|
+
- Package version: 1.0.78
|
|
11
|
+
- Generator version: 7.21.0
|
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
## Installation
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
require 'spartera_api_sdk'
|
|
18
|
-
require 'json'
|
|
19
|
-
|
|
20
|
-
# Configure client
|
|
21
|
-
SparteraApiSdk.configure do |config|
|
|
22
|
-
config.host = 'https://api.spartera.com'
|
|
23
|
-
config.api_key['X-API-Key'] = 'your-api-key-here'
|
|
24
|
-
end
|
|
25
|
-
|
|
26
|
-
COMPANY_ID = 'your-company-id'
|
|
27
|
-
USER_ID = 'your-user-id'
|
|
28
|
-
|
|
29
|
-
def sell_data_product
|
|
30
|
-
# Step 1: Discover available data platforms
|
|
31
|
-
puts '🔍 Step 1: Discovering available platforms...'
|
|
32
|
-
cloud_providers_api = SparteraApiSdk::CloudProvidersApi.new
|
|
33
|
-
|
|
34
|
-
engines = cloud_providers_api.cloud_providers_get
|
|
35
|
-
bigquery_engine_id = 1 # BigQuery engine ID
|
|
36
|
-
puts "✅ Found #{engines.length} supported platforms"
|
|
37
|
-
|
|
38
|
-
# Step 2: Create a data connection (with credentials in one call!)
|
|
39
|
-
puts '🔗 Step 2: Creating BigQuery connection...'
|
|
40
|
-
connections_api = SparteraApiSdk::ConnectionsApi.new
|
|
41
|
-
|
|
42
|
-
# Your BigQuery service account JSON (replace with your actual credentials)
|
|
43
|
-
service_account_json = {
|
|
44
|
-
type: 'service_account',
|
|
45
|
-
project_id: 'your-project-id',
|
|
46
|
-
private_key_id: 'key-id',
|
|
47
|
-
private_key: "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n",
|
|
48
|
-
client_email: 'your-service@your-project.iam.gserviceaccount.com',
|
|
49
|
-
client_id: 'client-id',
|
|
50
|
-
auth_uri: 'https://accounts.google.com/o/oauth2/auth',
|
|
51
|
-
token_uri: 'https://oauth2.googleapis.com/token'
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
connection_data = SparteraApiSdk::Connection.new(
|
|
55
|
-
company_id: COMPANY_ID,
|
|
56
|
-
user_id: USER_ID,
|
|
57
|
-
engine_id: bigquery_engine_id,
|
|
58
|
-
name: 'My BigQuery Data Warehouse',
|
|
59
|
-
description: "Connection to our company's analytics data",
|
|
60
|
-
visibility: 'PRIVATE',
|
|
61
|
-
credential_type: 'SERVICE_ACCOUNT',
|
|
62
|
-
credentials: service_account_json.to_json,
|
|
63
|
-
verified_usage_ability: true # Legal compliance - you have rights to this data
|
|
64
|
-
)
|
|
65
|
-
|
|
66
|
-
connection = connections_api.companies_company_id_connections_post(COMPANY_ID, connection_data)
|
|
67
|
-
connection_id = connection.connection_id
|
|
68
|
-
puts "✅ Created connection: #{connection_id}"
|
|
69
|
-
|
|
70
|
-
# Step 3: Create a marketplace asset
|
|
71
|
-
puts '📊 Step 3: Creating marketplace asset...'
|
|
72
|
-
assets_api = SparteraApiSdk::AssetsApi.new
|
|
73
|
-
|
|
74
|
-
asset_data = SparteraApiSdk::Asset.new(
|
|
75
|
-
name: 'Average Temperature Analytics',
|
|
76
|
-
description: 'Real-time weather temperature analytics from our IoT sensors across major cities',
|
|
77
|
-
company_id: COMPANY_ID,
|
|
78
|
-
connection_id: connection_id,
|
|
79
|
-
asset_type: 'CALCULATION',
|
|
80
|
-
sql_logic: 'SELECT AVERAGE(temperature) AS avg_temp, city, COUNT(*) AS readings FROM `your-project.weather.sensor_data` WHERE timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 24 HOUR) GROUP BY city ORDER BY avg_temp DESC',
|
|
81
|
-
sell_in_marketplace: true, # 🔥 This makes it available for purchase!
|
|
82
|
-
source: 'MANUAL',
|
|
83
|
-
visibility: 'PUBLIC'
|
|
84
|
-
)
|
|
85
|
-
|
|
86
|
-
asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
|
|
87
|
-
asset_id = asset.asset_id
|
|
88
|
-
puts "✅ Created marketplace asset: #{asset_id}"
|
|
89
|
-
|
|
90
|
-
# Step 4: Set your price and start earning!
|
|
91
|
-
puts '💰 Step 4: Setting price...'
|
|
92
|
-
pricing_api = SparteraApiSdk::AssetPriceHistoryApi.new
|
|
93
|
-
|
|
94
|
-
price_data = SparteraApiSdk::Assetpricehistory.new(
|
|
95
|
-
price_usd: 2.00 # $2.00 per analysis (credits calculated automatically)
|
|
96
|
-
)
|
|
97
|
-
|
|
98
|
-
price = pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, price_data)
|
|
99
|
-
puts "✅ Price set: $#{price.price_usd} (≈#{price.price_credits} credits)"
|
|
100
|
-
|
|
101
|
-
puts "\n🎉 SUCCESS! Your data product is now live on the Spartera marketplace!"
|
|
102
|
-
puts "📈 Asset URL: https://marketplace.spartera.com/assets/#{asset_id}"
|
|
103
|
-
puts '💡 Customers can now discover and purchase your analytics!'
|
|
104
|
-
rescue SparteraApiSdk::ApiError => e
|
|
105
|
-
puts "Error: #{e.message}"
|
|
106
|
-
raise e
|
|
107
|
-
end
|
|
108
|
-
|
|
109
|
-
# Run the function
|
|
110
|
-
sell_data_product
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
**That's it!** You're now selling data analytics. Every time someone runs your analysis, you earn money!
|
|
114
|
-
|
|
115
|
-
### 🎯 What You Just Built
|
|
116
|
-
- **Data Connection**: Secure link to your BigQuery warehouse
|
|
117
|
-
- **Analytics Product**: Temperature analysis that buyers can purchase
|
|
118
|
-
- **Marketplace Listing**: Your product is discoverable by thousands of potential customers
|
|
119
|
-
- **Automated Pricing**: Credits are calculated automatically based on your USD price
|
|
120
|
-
|
|
121
|
-
### 💰 Revenue Model
|
|
122
|
-
- You set the price ($2.00 in this example)
|
|
123
|
-
- Customers pay in credits (auto-converted)
|
|
124
|
-
- You earn revenue each time someone uses your analytics
|
|
125
|
-
- Spartera handles billing, payments, and customer support
|
|
126
|
-
|
|
127
|
-
---
|
|
128
|
-
|
|
129
|
-
## 📚 Detailed Documentation
|
|
130
|
-
|
|
131
|
-
### Authentication
|
|
132
|
-
|
|
133
|
-
Get your API key from the [Spartera Dashboard](https://app.spartera.com/settings/api-keys):
|
|
134
|
-
|
|
135
|
-
```ruby
|
|
136
|
-
require 'spartera_api_sdk'
|
|
137
|
-
|
|
138
|
-
# Option 1: Direct configuration
|
|
139
|
-
SparteraApiSdk.configure do |config|
|
|
140
|
-
config.host = 'https://api.spartera.com'
|
|
141
|
-
config.api_key['X-API-Key'] = 'your-api-key-here'
|
|
142
|
-
end
|
|
143
|
-
|
|
144
|
-
# Option 2: Environment variables (recommended)
|
|
145
|
-
ENV['SPARTERA_API_KEY'] = 'your-api-key'
|
|
146
|
-
ENV['SPARTERA_COMPANY_ID'] = 'your-company-id'
|
|
147
|
-
|
|
148
|
-
SparteraApiSdk.configure do |config|
|
|
149
|
-
config.host = 'https://api.spartera.com'
|
|
150
|
-
config.api_key['X-API-Key'] = ENV['SPARTERA_API_KEY']
|
|
151
|
-
end
|
|
152
|
-
|
|
153
|
-
# Create API instances
|
|
154
|
-
companies_api = SparteraApiSdk::CompaniesApi.new
|
|
155
|
-
assets_api = SparteraApiSdk::AssetsApi.new
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Environment Variables
|
|
159
|
-
|
|
160
|
-
```bash
|
|
161
|
-
export SPARTERA_API_KEY="your-api-key"
|
|
162
|
-
export SPARTERA_COMPANY_ID="your-company-id"
|
|
163
|
-
export SPARTERA_API_BASE_URL="https://api.spartera.com"
|
|
164
|
-
```
|
|
16
|
+
### Build a gem
|
|
165
17
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
Create connections to different data platforms:
|
|
169
|
-
|
|
170
|
-
```ruby
|
|
171
|
-
# BigQuery
|
|
172
|
-
bigquery_credentials = {
|
|
173
|
-
type: 'service_account',
|
|
174
|
-
project_id: 'your-project',
|
|
175
|
-
# ... your service account JSON
|
|
176
|
-
}
|
|
18
|
+
To build the Ruby code into a gem:
|
|
177
19
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
credential_type: 'USERNAME_PASSWORD',
|
|
181
|
-
username: 'your-username',
|
|
182
|
-
password: 'your-password'
|
|
183
|
-
)
|
|
184
|
-
|
|
185
|
-
# API Data Source
|
|
186
|
-
api_connection = SparteraApiSdk::Connection.new(
|
|
187
|
-
credential_type: 'API_KEY',
|
|
188
|
-
api_endpoint: 'https://api.yourcompany.com/data',
|
|
189
|
-
api_key_param: 'x-api-key',
|
|
190
|
-
credentials: 'your-api-key-value'
|
|
191
|
-
)
|
|
20
|
+
```shell
|
|
21
|
+
gem build spartera_api_sdk.gemspec
|
|
192
22
|
```
|
|
193
23
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
Create different types of marketplace products:
|
|
24
|
+
Then either install the gem locally:
|
|
197
25
|
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
calculation_asset = SparteraApiSdk::Asset.new(
|
|
201
|
-
asset_type: 'CALCULATION',
|
|
202
|
-
sql_logic: 'SELECT COUNT(*) as total_sales, AVG(amount) as avg_order FROM sales WHERE date >= CURRENT_DATE()'
|
|
203
|
-
)
|
|
204
|
-
|
|
205
|
-
# Visualization/Dashboard
|
|
206
|
-
visualization_asset = SparteraApiSdk::Asset.new(
|
|
207
|
-
asset_type: 'VISUALIZATION',
|
|
208
|
-
viz_chart_type: 'BAR',
|
|
209
|
-
viz_dep_var_col_name: 'sales_amount',
|
|
210
|
-
viz_indep_var_col_name: 'month'
|
|
211
|
-
)
|
|
26
|
+
```shell
|
|
27
|
+
gem install ./spartera_api_sdk-1.0.78.gem
|
|
212
28
|
```
|
|
213
29
|
|
|
214
|
-
|
|
30
|
+
(for development, run `gem install --dev ./spartera_api_sdk-1.0.78.gem` to install the development dependencies)
|
|
215
31
|
|
|
216
|
-
|
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
217
33
|
|
|
218
|
-
|
|
219
|
-
# Fixed price per analysis
|
|
220
|
-
basic_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 1.50)
|
|
221
|
-
|
|
222
|
-
# Premium analytics
|
|
223
|
-
premium_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 10.00)
|
|
224
|
-
|
|
225
|
-
# Bulk discount with sales
|
|
226
|
-
sale_pricing = SparteraApiSdk::Assetpricehistory.new(
|
|
227
|
-
price_usd: 5.00,
|
|
228
|
-
discount_percentage: 20.0,
|
|
229
|
-
sale_start_date: '2024-01-01T00:00:00Z',
|
|
230
|
-
sale_end_date: '2024-01-31T23:59:59Z'
|
|
231
|
-
)
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
### Marketplace Management
|
|
34
|
+
Finally add this to the Gemfile:
|
|
235
35
|
|
|
236
|
-
|
|
36
|
+
gem 'spartera_api_sdk', '~> 1.0.78'
|
|
237
37
|
|
|
238
|
-
|
|
239
|
-
# Update asset details
|
|
240
|
-
update_data = SparteraApiSdk::Asset.new(
|
|
241
|
-
description: 'Updated description with new features'
|
|
242
|
-
)
|
|
243
|
-
assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, update_data)
|
|
244
|
-
|
|
245
|
-
# Change pricing
|
|
246
|
-
new_price = SparteraApiSdk::Assetpricehistory.new(price_usd: 3.00)
|
|
247
|
-
pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, new_price)
|
|
248
|
-
|
|
249
|
-
# Remove from marketplace (but keep private)
|
|
250
|
-
marketplace_update = SparteraApiSdk::Asset.new(sell_in_marketplace: false)
|
|
251
|
-
assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, marketplace_update)
|
|
252
|
-
|
|
253
|
-
# Get sales analytics
|
|
254
|
-
analytics = companies_api.companies_company_id_analytics_sales_get(COMPANY_ID)
|
|
255
|
-
puts "Total revenue: $#{analytics.total_revenue}"
|
|
256
|
-
```
|
|
38
|
+
### Install from Git
|
|
257
39
|
|
|
258
|
-
|
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
259
41
|
|
|
260
|
-
|
|
261
|
-
begin
|
|
262
|
-
asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
|
|
263
|
-
rescue SparteraApiSdk::ApiError => e
|
|
264
|
-
puts "API Error: #{e.message}"
|
|
265
|
-
puts "Status: #{e.code}"
|
|
266
|
-
puts "Response: #{e.response_body}"
|
|
267
|
-
|
|
268
|
-
# Handle specific errors
|
|
269
|
-
case e.code
|
|
270
|
-
when 400
|
|
271
|
-
puts 'Check your asset data format'
|
|
272
|
-
when 401
|
|
273
|
-
puts 'Check your API key'
|
|
274
|
-
when 403
|
|
275
|
-
puts 'Check your permissions'
|
|
276
|
-
when 404
|
|
277
|
-
puts 'Check your IDs'
|
|
278
|
-
else
|
|
279
|
-
puts "HTTP #{e.code}: #{e.message}"
|
|
280
|
-
end
|
|
281
|
-
|
|
282
|
-
raise e
|
|
283
|
-
end
|
|
284
|
-
```
|
|
42
|
+
gem 'spartera_api_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
285
43
|
|
|
286
|
-
###
|
|
44
|
+
### Include the Ruby code directly
|
|
287
45
|
|
|
288
|
-
|
|
289
|
-
# Batch operations
|
|
290
|
-
connection_ids = []
|
|
291
|
-
%w[bigquery snowflake redshift].each do |platform|
|
|
292
|
-
conn = connections_api.companies_company_id_connections_post(COMPANY_ID, platform_config)
|
|
293
|
-
connection_ids << conn.connection_id
|
|
294
|
-
end
|
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
|
295
47
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
COMPANY_ID,
|
|
299
|
-
asset_id,
|
|
300
|
-
{ limit: 10 }
|
|
301
|
-
)
|
|
302
|
-
|
|
303
|
-
# Performance analytics
|
|
304
|
-
performance = companies_api.companies_company_id_analytics_assets_get(
|
|
305
|
-
COMPANY_ID,
|
|
306
|
-
start_date: '2024-01-01',
|
|
307
|
-
end_date: '2024-12-31'
|
|
308
|
-
)
|
|
48
|
+
```shell
|
|
49
|
+
ruby -Ilib script.rb
|
|
309
50
|
```
|
|
310
51
|
|
|
311
|
-
|
|
52
|
+
## Getting Started
|
|
312
53
|
|
|
313
|
-
|
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
314
55
|
|
|
315
56
|
```ruby
|
|
316
|
-
#
|
|
317
|
-
|
|
57
|
+
# Load the gem
|
|
58
|
+
require 'spartera_api_sdk'
|
|
318
59
|
|
|
319
|
-
#
|
|
60
|
+
# Setup authorization
|
|
320
61
|
SparteraApiSdk.configure do |config|
|
|
321
|
-
|
|
322
|
-
config.api_key['
|
|
62
|
+
# Configure API key authorization: ApiKeyAuth
|
|
63
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
65
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
323
66
|
end
|
|
324
67
|
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
def self.get_company(company_id)
|
|
336
|
-
companies_api.companies_company_id_get(company_id)
|
|
337
|
-
rescue SparteraApiSdk::ApiError => e
|
|
338
|
-
Rails.logger.error "Spartera API Error: #{e.message}"
|
|
339
|
-
nil
|
|
340
|
-
end
|
|
341
|
-
end
|
|
68
|
+
api_instance = SparteraApiSdk::APIKeysApi.new
|
|
69
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
70
|
+
api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_abc123', role_id: 1}) # ApiKeysInput |
|
|
71
|
+
opts = {
|
|
72
|
+
page: 56, # Integer | Page number for pagination
|
|
73
|
+
limit: 56, # Integer | Number of items per page
|
|
74
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
75
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
76
|
+
search: 'search_example' # String | Search term to filter results
|
|
77
|
+
}
|
|
342
78
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
79
|
+
begin
|
|
80
|
+
#Create single API key. Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
|
|
81
|
+
result = api_instance.create_api_keys(company_id, api_keys_input, opts)
|
|
82
|
+
p result
|
|
83
|
+
rescue SparteraApiSdk::ApiError => e
|
|
84
|
+
puts "Exception when calling APIKeysApi->create_api_keys: #{e}"
|
|
349
85
|
end
|
|
86
|
+
|
|
350
87
|
```
|
|
351
88
|
|
|
352
|
-
##
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
89
|
+
## Documentation for API Endpoints
|
|
90
|
+
|
|
91
|
+
All URIs are relative to *https://api.spartera.com*
|
|
92
|
+
|
|
93
|
+
Class | Method | HTTP request | Description
|
|
94
|
+
------------ | ------------- | ------------- | -------------
|
|
95
|
+
*SparteraApiSdk::APIKeysApi* | [**create_api_keys**](docs/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.
|
|
96
|
+
*SparteraApiSdk::APIKeysApi* | [**create_api_keys_api_keys_revoke**](docs/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.
|
|
97
|
+
*SparteraApiSdk::APIKeysApi* | [**delete_api_keys**](docs/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.
|
|
98
|
+
*SparteraApiSdk::APIKeysApi* | [**get_api_keys_by_id**](docs/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).
|
|
99
|
+
*SparteraApiSdk::APIKeysApi* | [**get_api_keys_by_id_api_keys_stats**](docs/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.
|
|
100
|
+
*SparteraApiSdk::APIKeysApi* | [**list_api_keys**](docs/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).
|
|
101
|
+
*SparteraApiSdk::APIKeysApi* | [**update_api_keys**](docs/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).
|
|
102
|
+
*SparteraApiSdk::AlertsApi* | [**create_alerts**](docs/AlertsApi.md#create_alerts) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts
|
|
103
|
+
*SparteraApiSdk::AlertsApi* | [**delete_alerts**](docs/AlertsApi.md#delete_alerts) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID
|
|
104
|
+
*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id**](docs/AlertsApi.md#get_alerts_by_id) | **GET** /companies/{company_id}/users/{user_id}/alerts | Get a list of all alerts for a specific user
|
|
105
|
+
*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_asset_all**](docs/AlertsApi.md#get_alerts_by_id_asset_all) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset
|
|
106
|
+
*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_users**](docs/AlertsApi.md#get_alerts_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Get single alert by ID
|
|
107
|
+
*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_users_asset**](docs/AlertsApi.md#get_alerts_by_id_users_asset) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset (by user)
|
|
108
|
+
*SparteraApiSdk::AlertsApi* | [**update_alerts**](docs/AlertsApi.md#update_alerts) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID
|
|
109
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history**](docs/AssetPriceHistoryApi.md#create_asset_price_history) | **POST** /companies/{company_id}/assets/{asset_id}/prices | Create a new price history record for an asset
|
|
110
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history_prices_calculate_credits**](docs/AssetPriceHistoryApi.md#create_asset_price_history_prices_calculate_credits) | **POST** /companies/{company_id}/assets/{asset_id}/prices/calculate_credits | Calculate the credit equivalent for a given USD price without saving
|
|
111
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history_prices_discount**](docs/AssetPriceHistoryApi.md#create_asset_price_history_prices_discount) | **POST** /companies/{company_id}/assets/{asset_id}/prices/discount | POST /companies/{company_id}/assets/{asset_id}/prices/discount
|
|
112
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**delete_asset_price_history**](docs/AssetPriceHistoryApi.md#delete_asset_price_history) | **DELETE** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Delete single price history record by ID
|
|
113
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id) | **GET** /companies/{company_id}/assets/{asset_id}/prices | Get all price history records for a specific asset
|
|
114
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id_assets_prices**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id_assets_prices) | **GET** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Get single price history record by ID
|
|
115
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id_prices_active**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id_prices_active) | **GET** /companies/{company_id}/assets/{asset_id}/prices/active | Get the currently active price for an asset
|
|
116
|
+
*SparteraApiSdk::AssetPriceHistoryApi* | [**update_asset_price_history**](docs/AssetPriceHistoryApi.md#update_asset_price_history) | **PATCH** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Update an existing price history record by ID
|
|
117
|
+
*SparteraApiSdk::AssetUsecasesApi* | [**get_asset_usecases_by_id**](docs/AssetUsecasesApi.md#get_asset_usecases_by_id) | **GET** /asset_usecases/{auc_id} | Get single asset use case by ID
|
|
118
|
+
*SparteraApiSdk::AssetUsecasesApi* | [**list_asset_usecases**](docs/AssetUsecasesApi.md#list_asset_usecases) | **GET** /asset_usecases | Get a list of all asset use cases
|
|
119
|
+
*SparteraApiSdk::AssetsApi* | [**create_assets**](docs/AssetsApi.md#create_assets) | **POST** /companies/{company_id}/assets | Create a new asset
|
|
120
|
+
*SparteraApiSdk::AssetsApi* | [**create_assets_analyze**](docs/AssetsApi.md#create_assets_analyze) | **POST** /analyze/{company_handle}/assets/{asset_slug} | Process (analyze) an asset with dynamic rate limiting applied via decorator.
|
|
121
|
+
*SparteraApiSdk::AssetsApi* | [**create_assets_scan_column**](docs/AssetsApi.md#create_assets_scan_column) | **POST** /companies/{company_id}/assets/{asset_id}/scan_column | Scan a column in the asset's table to retrieve distinct values Request Body: column (str): Column name to scan limit (int, optional): Maximum distinct values to return (default 1000, max 5000) Returns: Flask Response with scan results
|
|
122
|
+
*SparteraApiSdk::AssetsApi* | [**create_assets_test**](docs/AssetsApi.md#create_assets_test) | **POST** /companies/{company_id}/assets/{asset_id}/test | POST /companies/{company_id}/assets/{asset_id}/test
|
|
123
|
+
*SparteraApiSdk::AssetsApi* | [**delete_assets**](docs/AssetsApi.md#delete_assets) | **DELETE** /companies/{company_id}/assets/{asset_id} | Delete single asset by ID
|
|
124
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id**](docs/AssetsApi.md#get_assets_by_id) | **GET** /companies/{company_id}/assets/{asset_id} | Get single asset by ID
|
|
125
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id2**](docs/AssetsApi.md#get_assets_by_id2) | **GET** /companies/{company_id}/assets/{asset_id}/statistics | Get statistics for a specific asset (public endpoint)
|
|
126
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_analyze**](docs/AssetsApi.md#get_assets_by_id_analyze) | **GET** /analyze/{company_handle}/assets/{asset_slug} | Process (analyze) an asset with dynamic rate limiting applied via decorator.
|
|
127
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_infoschema**](docs/AssetsApi.md#get_assets_by_id_infoschema) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema | Get the information schema for a specific asset's table
|
|
128
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_infoschema_save**](docs/AssetsApi.md#get_assets_by_id_infoschema_save) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema/save | Retrieve and save an asset's information schema
|
|
129
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_predicted_price**](docs/AssetsApi.md#get_assets_by_id_predicted_price) | **GET** /companies/{company_id}/assets/{asset_id}/predicted_price | Get AI-predicted pricing for a specific asset
|
|
130
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_statistics**](docs/AssetsApi.md#get_assets_by_id_statistics) | **GET** /companies/{company_id}/assets/statistics | Get statistics for all assets the user has access to
|
|
131
|
+
*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_test**](docs/AssetsApi.md#get_assets_by_id_test) | **GET** /companies/{company_id}/assets/{asset_id}/test | GET /companies/{company_id}/assets/{asset_id}/test
|
|
132
|
+
*SparteraApiSdk::AssetsApi* | [**list_assets**](docs/AssetsApi.md#list_assets) | **GET** /companies/{company_id}/assets | Get all assets for a specific company
|
|
133
|
+
*SparteraApiSdk::AssetsApi* | [**list_assets_search**](docs/AssetsApi.md#list_assets_search) | **GET** /companies/{company_id}/assets/search | Search and filter assets with advanced options Query Parameters: q: Search query string category: Filter by category sport: Filter by sport tag sort_by: Sort field (name|recent|popular|trending) limit: Number of results (default 20, max 100) offset: Offset for pagination include_recommended: Include recommendations (true/false) include_schema: Include asset_schema in response (true/false, default false)
|
|
134
|
+
*SparteraApiSdk::AssetsApi* | [**update_assets**](docs/AssetsApi.md#update_assets) | **PATCH** /companies/{company_id}/assets/{asset_id} | Update an existing asset by ID
|
|
135
|
+
*SparteraApiSdk::CloudProvidersApi* | [**get_cloud_providers_by_id**](docs/CloudProvidersApi.md#get_cloud_providers_by_id) | **GET** /cloud-providers/{provider_id} | Get single cloud provider by ID
|
|
136
|
+
*SparteraApiSdk::CloudProvidersApi* | [**list_cloud_providers**](docs/CloudProvidersApi.md#list_cloud_providers) | **GET** /cloud-providers | Get a list of all cloud providers
|
|
137
|
+
*SparteraApiSdk::CompaniesApi* | [**get_companies_by_id**](docs/CompaniesApi.md#get_companies_by_id) | **GET** /companies/{company_id} | Get details of the requestor's own company
|
|
138
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies**](docs/CompaniesApi.md#list_companies) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company's current subscription plan.
|
|
139
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_assets**](docs/CompaniesApi.md#list_companies_analytics_assets) | **GET** /companies/{company_id}/analytics/assets | Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
|
|
140
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_customers**](docs/CompaniesApi.md#list_companies_analytics_customers) | **GET** /companies/{company_id}/analytics/customers | Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
|
|
141
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_dashboard**](docs/CompaniesApi.md#list_companies_analytics_dashboard) | **GET** /companies/{company_id}/analytics/dashboard | Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
|
|
142
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_metrics**](docs/CompaniesApi.md#list_companies_analytics_metrics) | **GET** /companies/{company_id}/analytics/metrics | Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
|
|
143
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_sales**](docs/CompaniesApi.md#list_companies_analytics_sales) | **GET** /companies/{company_id}/analytics/sales | Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
144
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_objects**](docs/CompaniesApi.md#list_companies_objects) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company
|
|
145
|
+
*SparteraApiSdk::CompaniesApi* | [**list_companies_requests_usage**](docs/CompaniesApi.md#list_companies_requests_usage) | **GET** /companies/{company_id}/requests/usage | Get company request usage data for a specific month.
|
|
146
|
+
*SparteraApiSdk::CompaniesApi* | [**update_companies**](docs/CompaniesApi.md#update_companies) | **PATCH** /companies/{company_id} | Update an existing company by ID
|
|
147
|
+
*SparteraApiSdk::ConnectionsApi* | [**create_connections**](docs/ConnectionsApi.md#create_connections) | **POST** /companies/{company_id}/connections | Create a new connection by ID
|
|
148
|
+
*SparteraApiSdk::ConnectionsApi* | [**delete_connections**](docs/ConnectionsApi.md#delete_connections) | **DELETE** /companies/{company_id}/connections/{connection_id} | Delete single connection by ID
|
|
149
|
+
*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id**](docs/ConnectionsApi.md#get_connections_by_id) | **GET** /companies/{company_id}/connections/{connection_id} | Get single connection by ID
|
|
150
|
+
*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id2**](docs/ConnectionsApi.md#get_connections_by_id2) | **GET** /companies/{company_id}/connections/{connection_id}/test | Test the specified connection
|
|
151
|
+
*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id_infoschema**](docs/ConnectionsApi.md#get_connections_by_id_infoschema) | **GET** /companies/{company_id}/connections/{connection_id}/infoschema | Retrieve the information schema for the specified connection
|
|
152
|
+
*SparteraApiSdk::ConnectionsApi* | [**list_connections**](docs/ConnectionsApi.md#list_connections) | **GET** /companies/{company_id}/connections | Get all connections for a specific company
|
|
153
|
+
*SparteraApiSdk::ConnectionsApi* | [**update_connections**](docs/ConnectionsApi.md#update_connections) | **PATCH** /companies/{company_id}/connections/{connection_id} | Update an existing connection by ID
|
|
154
|
+
*SparteraApiSdk::EndpointsApi* | [**create_endpoints**](docs/EndpointsApi.md#create_endpoints) | **POST** /companies/{company_id}/endpoints | Create a new endpoint
|
|
155
|
+
*SparteraApiSdk::EndpointsApi* | [**create_endpoints_keys**](docs/EndpointsApi.md#create_endpoints_keys) | **POST** /companies/{company_id}/endpoints/{endpoint_id}/keys | POST /companies/{company_id}/endpoints/{endpoint_id}/keys
|
|
156
|
+
*SparteraApiSdk::EndpointsApi* | [**delete_endpoints**](docs/EndpointsApi.md#delete_endpoints) | **DELETE** /companies/{company_id}/endpoints/{endpoint_id} | Delete single endpoint by ID
|
|
157
|
+
*SparteraApiSdk::EndpointsApi* | [**delete_endpoints_keys**](docs/EndpointsApi.md#delete_endpoints_keys) | **DELETE** /companies/{company_id}/endpoints/{endpoint_id}/keys/{api_key_id} | DELETE /companies/{company_id}/endpoints/{endpoint_id}/keys/{api_key_id}
|
|
158
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id**](docs/EndpointsApi.md#get_endpoints_by_id) | **GET** /companies/{company_id}/endpoints/{endpoint_id} | Get single endpoint by ID
|
|
159
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_available_endpoints**](docs/EndpointsApi.md#get_endpoints_by_id_available_endpoints) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/available-endpoints | GET /companies/{company_id}/endpoints/{endpoint_id}/available-endpoints
|
|
160
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_connections_describe**](docs/EndpointsApi.md#get_endpoints_by_id_connections_describe) | **GET** /companies/{company_id}/endpoints/../connections/{connection_id}/describe | Get schema information for a connection Query parameters: include_fields: Whether to include field information (default: true) schemas: Optional comma-separated schemas to include tables: Optional comma-separated tables to include
|
|
161
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_execute**](docs/EndpointsApi.md#get_endpoints_by_id_execute) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/execute | Execute an endpoint with pagination support. Customer-facing route that returns paginated data. Query params: ?start=0&limit=100
|
|
162
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_keys**](docs/EndpointsApi.md#get_endpoints_by_id_keys) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/keys | GET /companies/{company_id}/endpoints/{endpoint_id}/keys
|
|
163
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_stats**](docs/EndpointsApi.md#get_endpoints_by_id_stats) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/stats | Get usage statistics for an endpoint Query parameters: days: Number of days to analyze (default: 30)
|
|
164
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_test**](docs/EndpointsApi.md#get_endpoints_by_id_test) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/test | Test an endpoint with sample data Request body (optional): limit: Number of sample rows to return (default: 10)
|
|
165
|
+
*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_url**](docs/EndpointsApi.md#get_endpoints_by_id_url) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/url | GET /companies/{company_id}/endpoints/{endpoint_id}/url
|
|
166
|
+
*SparteraApiSdk::EndpointsApi* | [**list_endpoints**](docs/EndpointsApi.md#list_endpoints) | **GET** /companies/{company_id}/endpoints | Get all endpoints for a specific company with pagination, filtering, and sorting
|
|
167
|
+
*SparteraApiSdk::EndpointsApi* | [**update_endpoints**](docs/EndpointsApi.md#update_endpoints) | **PATCH** /companies/{company_id}/endpoints/{endpoint_id} | Update an existing endpoint by ID
|
|
168
|
+
*SparteraApiSdk::FavoritesApi* | [**create_favorites**](docs/FavoritesApi.md#create_favorites) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites
|
|
169
|
+
*SparteraApiSdk::FavoritesApi* | [**delete_favorites**](docs/FavoritesApi.md#delete_favorites) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset)
|
|
170
|
+
*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id**](docs/FavoritesApi.md#get_favorites_by_id) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user
|
|
171
|
+
*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users**](docs/FavoritesApi.md#get_favorites_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID
|
|
172
|
+
*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_category**](docs/FavoritesApi.md#get_favorites_by_id_users_category) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category
|
|
173
|
+
*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_check**](docs/FavoritesApi.md#get_favorites_by_id_users_check) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset
|
|
174
|
+
*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_uncategorized**](docs/FavoritesApi.md#get_favorites_by_id_users_uncategorized) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category
|
|
175
|
+
*SparteraApiSdk::FavoritesApi* | [**update_favorites**](docs/FavoritesApi.md#update_favorites) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID
|
|
176
|
+
*SparteraApiSdk::IndustriesApi* | [**get_industries_by_id**](docs/IndustriesApi.md#get_industries_by_id) | **GET** /industries/{industry_id} | Get single industry by ID
|
|
177
|
+
*SparteraApiSdk::IndustriesApi* | [**list_industries**](docs/IndustriesApi.md#list_industries) | **GET** /industries | Get a list of all industries
|
|
178
|
+
*SparteraApiSdk::IndustriesApi* | [**list_industries_active**](docs/IndustriesApi.md#list_industries_active) | **GET** /industries/active | Get a list of industries that have active marketplace products
|
|
179
|
+
*SparteraApiSdk::JobFunctionsApi* | [**get_job_functions_by_id**](docs/JobFunctionsApi.md#get_job_functions_by_id) | **GET** /job-functions/{function_id} | Get single job function by ID
|
|
180
|
+
*SparteraApiSdk::JobFunctionsApi* | [**list_job_functions**](docs/JobFunctionsApi.md#list_job_functions) | **GET** /job-functions | Get a list of all job functions
|
|
181
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**create_postgen_integrations**](docs/PostgenIntegrationsApi.md#create_postgen_integrations) | **POST** /companies/{company_id}/postgen_integrations | POST /companies/{company_id}/postgen_integrations
|
|
182
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**create_postgen_integrations_test**](docs/PostgenIntegrationsApi.md#create_postgen_integrations_test) | **POST** /companies/{company_id}/postgen_integrations/test | POST /companies/{company_id}/postgen_integrations/test
|
|
183
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**delete_postgen_integrations**](docs/PostgenIntegrationsApi.md#delete_postgen_integrations) | **DELETE** /companies/{company_id}/postgen_integrations/{integration_id} | Delete single integration by ID. Also deletes credentials from GCP Secret Manager.
|
|
184
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**get_postgen_integrations_by_id**](docs/PostgenIntegrationsApi.md#get_postgen_integrations_by_id) | **GET** /companies/{company_id}/postgen_integrations/{integration_id} | Get single integration by ID.
|
|
185
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**list_postgen_integrations**](docs/PostgenIntegrationsApi.md#list_postgen_integrations) | **GET** /companies/{company_id}/postgen_integrations | Get a list of all postgen integrations for the company. All company users can view integrations.
|
|
186
|
+
*SparteraApiSdk::PostgenIntegrationsApi* | [**update_postgen_integrations**](docs/PostgenIntegrationsApi.md#update_postgen_integrations) | **PATCH** /companies/{company_id}/postgen_integrations/{integration_id} | Update an existing integration by ID. Can update credentials, is_active status, etc.
|
|
187
|
+
*SparteraApiSdk::PostsApi* | [**create_posts**](docs/PostsApi.md#create_posts) | **POST** /companies/{company_id}/posts | POST /companies/{company_id}/posts
|
|
188
|
+
*SparteraApiSdk::PostsApi* | [**create_posts2**](docs/PostsApi.md#create_posts2) | **POST** /companies/{company_id}/posts/{post_id}/publish/{integration_id} | Publish a post to an external platform via an integration. Args: post_id: ID of the post to publish integration_id: ID of the integration to use (from postgen_integrations) Returns: Publication record with external_url and external_post_id
|
|
189
|
+
*SparteraApiSdk::PostsApi* | [**create_posts_publish**](docs/PostsApi.md#create_posts_publish) | **POST** /companies/{company_id}/posts/{post_id}/publish | Publish a post (make it publicly visible).
|
|
190
|
+
*SparteraApiSdk::PostsApi* | [**create_posts_unpublish**](docs/PostsApi.md#create_posts_unpublish) | **POST** /companies/{company_id}/posts/{post_id}/unpublish | Unpublish a post (make it private/draft again).
|
|
191
|
+
*SparteraApiSdk::PostsApi* | [**create_posts_view**](docs/PostsApi.md#create_posts_view) | **POST** /companies/{company_id}/posts/{post_id}/view | Increment view count for a post. Public endpoint (no authentication required).
|
|
192
|
+
*SparteraApiSdk::PostsApi* | [**delete_posts**](docs/PostsApi.md#delete_posts) | **DELETE** /companies/{company_id}/posts/{post_id} | Delete single post by ID.
|
|
193
|
+
*SparteraApiSdk::PostsApi* | [**get_posts_by_id**](docs/PostsApi.md#get_posts_by_id) | **GET** /companies/{company_id}/posts/{post_id} | Get single post by ID.
|
|
194
|
+
*SparteraApiSdk::PostsApi* | [**get_posts_by_id_publications**](docs/PostsApi.md#get_posts_by_id_publications) | **GET** /companies/{company_id}/posts/{post_id}/publications | Get all publications for a post. Shows where this post has been published to external platforms. Returns: Array of publication records with platform, URL, status
|
|
195
|
+
*SparteraApiSdk::PostsApi* | [**list_posts**](docs/PostsApi.md#list_posts) | **GET** /companies/{company_id}/posts | Get a list of all posts for the user's company. Supports filtering, sorting, pagination.
|
|
196
|
+
*SparteraApiSdk::PostsApi* | [**list_posts_summary**](docs/PostsApi.md#list_posts_summary) | **GET** /companies/{company_id}/posts/summary | GET /companies/{company_id}/posts/summary
|
|
197
|
+
*SparteraApiSdk::PostsApi* | [**update_posts**](docs/PostsApi.md#update_posts) | **PATCH** /companies/{company_id}/posts/{post_id} | Update an existing post by ID. Note: last_edited_at is automatically updated.
|
|
198
|
+
*SparteraApiSdk::StorageEnginesApi* | [**get_storage_engines_by_id**](docs/StorageEnginesApi.md#get_storage_engines_by_id) | **GET** /cloud-providers/{provider_id}/storage-engines/{engine_id} | Get single storage engine by ID
|
|
199
|
+
*SparteraApiSdk::StorageEnginesApi* | [**list_storage_engines**](docs/StorageEnginesApi.md#list_storage_engines) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines
|
|
200
|
+
*SparteraApiSdk::UsersApi* | [**create_users**](docs/UsersApi.md#create_users) | **POST** /companies/{company_id}/users | Create a new user
|
|
201
|
+
*SparteraApiSdk::UsersApi* | [**create_users_google_oauth**](docs/UsersApi.md#create_users_google_oauth) | **POST** /companies/{company_id}/users/google-oauth | POST /companies/{company_id}/users/google-oauth
|
|
202
|
+
*SparteraApiSdk::UsersApi* | [**create_users_logout**](docs/UsersApi.md#create_users_logout) | **POST** /companies/{company_id}/users/logout | Logout current user by revoking their sessions
|
|
203
|
+
*SparteraApiSdk::UsersApi* | [**delete_users**](docs/UsersApi.md#delete_users) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID
|
|
204
|
+
*SparteraApiSdk::UsersApi* | [**get_users_by_id**](docs/UsersApi.md#get_users_by_id) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID
|
|
205
|
+
*SparteraApiSdk::UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /companies/{company_id}/users | Get a list of all users in a company
|
|
206
|
+
*SparteraApiSdk::UsersApi* | [**list_users_me**](docs/UsersApi.md#list_users_me) | **GET** /me | Get current authenticated user's profile.
|
|
207
|
+
*SparteraApiSdk::UsersApi* | [**update_users**](docs/UsersApi.md#update_users) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
## Documentation for Models
|
|
211
|
+
|
|
212
|
+
- [SparteraApiSdk::Alerts](docs/Alerts.md)
|
|
213
|
+
- [SparteraApiSdk::AlertsInput](docs/AlertsInput.md)
|
|
214
|
+
- [SparteraApiSdk::AlertsUpdate](docs/AlertsUpdate.md)
|
|
215
|
+
- [SparteraApiSdk::ApiKeys](docs/ApiKeys.md)
|
|
216
|
+
- [SparteraApiSdk::ApiKeysInput](docs/ApiKeysInput.md)
|
|
217
|
+
- [SparteraApiSdk::ApiKeysUpdate](docs/ApiKeysUpdate.md)
|
|
218
|
+
- [SparteraApiSdk::AssetPriceHistory](docs/AssetPriceHistory.md)
|
|
219
|
+
- [SparteraApiSdk::AssetPriceHistoryInput](docs/AssetPriceHistoryInput.md)
|
|
220
|
+
- [SparteraApiSdk::AssetPriceHistoryUpdate](docs/AssetPriceHistoryUpdate.md)
|
|
221
|
+
- [SparteraApiSdk::AssetUsecases](docs/AssetUsecases.md)
|
|
222
|
+
- [SparteraApiSdk::Assets](docs/Assets.md)
|
|
223
|
+
- [SparteraApiSdk::AssetsInput](docs/AssetsInput.md)
|
|
224
|
+
- [SparteraApiSdk::AssetsUpdate](docs/AssetsUpdate.md)
|
|
225
|
+
- [SparteraApiSdk::CloudProviders](docs/CloudProviders.md)
|
|
226
|
+
- [SparteraApiSdk::CloudProvidersInput](docs/CloudProvidersInput.md)
|
|
227
|
+
- [SparteraApiSdk::CloudProvidersUpdate](docs/CloudProvidersUpdate.md)
|
|
228
|
+
- [SparteraApiSdk::Companies](docs/Companies.md)
|
|
229
|
+
- [SparteraApiSdk::CompaniesInput](docs/CompaniesInput.md)
|
|
230
|
+
- [SparteraApiSdk::CompaniesUpdate](docs/CompaniesUpdate.md)
|
|
231
|
+
- [SparteraApiSdk::Connections](docs/Connections.md)
|
|
232
|
+
- [SparteraApiSdk::ConnectionsInput](docs/ConnectionsInput.md)
|
|
233
|
+
- [SparteraApiSdk::ConnectionsUpdate](docs/ConnectionsUpdate.md)
|
|
234
|
+
- [SparteraApiSdk::CreateAlerts200Response](docs/CreateAlerts200Response.md)
|
|
235
|
+
- [SparteraApiSdk::CreateAlerts200ResponseData](docs/CreateAlerts200ResponseData.md)
|
|
236
|
+
- [SparteraApiSdk::CreateApiKeys200Response](docs/CreateApiKeys200Response.md)
|
|
237
|
+
- [SparteraApiSdk::CreateApiKeys200ResponseData](docs/CreateApiKeys200ResponseData.md)
|
|
238
|
+
- [SparteraApiSdk::CreateAssetPriceHistory200Response](docs/CreateAssetPriceHistory200Response.md)
|
|
239
|
+
- [SparteraApiSdk::CreateAssetPriceHistory200ResponseData](docs/CreateAssetPriceHistory200ResponseData.md)
|
|
240
|
+
- [SparteraApiSdk::CreateAssetsAnalyze200Response](docs/CreateAssetsAnalyze200Response.md)
|
|
241
|
+
- [SparteraApiSdk::CreateAssetsAnalyze200ResponseData](docs/CreateAssetsAnalyze200ResponseData.md)
|
|
242
|
+
- [SparteraApiSdk::CreateConnections200Response](docs/CreateConnections200Response.md)
|
|
243
|
+
- [SparteraApiSdk::CreateConnections200ResponseData](docs/CreateConnections200ResponseData.md)
|
|
244
|
+
- [SparteraApiSdk::CreateEndpoints200Response](docs/CreateEndpoints200Response.md)
|
|
245
|
+
- [SparteraApiSdk::CreateEndpoints200ResponseData](docs/CreateEndpoints200ResponseData.md)
|
|
246
|
+
- [SparteraApiSdk::CreateFavorites200Response](docs/CreateFavorites200Response.md)
|
|
247
|
+
- [SparteraApiSdk::CreateFavorites200ResponseData](docs/CreateFavorites200ResponseData.md)
|
|
248
|
+
- [SparteraApiSdk::CreatePostgenIntegrations200Response](docs/CreatePostgenIntegrations200Response.md)
|
|
249
|
+
- [SparteraApiSdk::CreatePostgenIntegrations200ResponseData](docs/CreatePostgenIntegrations200ResponseData.md)
|
|
250
|
+
- [SparteraApiSdk::CreatePosts200Response](docs/CreatePosts200Response.md)
|
|
251
|
+
- [SparteraApiSdk::CreatePosts200ResponseData](docs/CreatePosts200ResponseData.md)
|
|
252
|
+
- [SparteraApiSdk::CreateUsers200Response](docs/CreateUsers200Response.md)
|
|
253
|
+
- [SparteraApiSdk::CreateUsers200ResponseData](docs/CreateUsers200ResponseData.md)
|
|
254
|
+
- [SparteraApiSdk::DeleteAlerts200Response](docs/DeleteAlerts200Response.md)
|
|
255
|
+
- [SparteraApiSdk::DeleteAlerts200ResponseData](docs/DeleteAlerts200ResponseData.md)
|
|
256
|
+
- [SparteraApiSdk::DeleteApiKeys200Response](docs/DeleteApiKeys200Response.md)
|
|
257
|
+
- [SparteraApiSdk::DeleteApiKeys200ResponseData](docs/DeleteApiKeys200ResponseData.md)
|
|
258
|
+
- [SparteraApiSdk::DeleteAssetPriceHistory200Response](docs/DeleteAssetPriceHistory200Response.md)
|
|
259
|
+
- [SparteraApiSdk::DeleteAssetPriceHistory200ResponseData](docs/DeleteAssetPriceHistory200ResponseData.md)
|
|
260
|
+
- [SparteraApiSdk::DeleteAssets200Response](docs/DeleteAssets200Response.md)
|
|
261
|
+
- [SparteraApiSdk::DeleteAssets200ResponseData](docs/DeleteAssets200ResponseData.md)
|
|
262
|
+
- [SparteraApiSdk::DeleteConnections200Response](docs/DeleteConnections200Response.md)
|
|
263
|
+
- [SparteraApiSdk::DeleteConnections200ResponseData](docs/DeleteConnections200ResponseData.md)
|
|
264
|
+
- [SparteraApiSdk::DeleteEndpoints200Response](docs/DeleteEndpoints200Response.md)
|
|
265
|
+
- [SparteraApiSdk::DeleteEndpoints200ResponseData](docs/DeleteEndpoints200ResponseData.md)
|
|
266
|
+
- [SparteraApiSdk::DeleteFavorites200Response](docs/DeleteFavorites200Response.md)
|
|
267
|
+
- [SparteraApiSdk::DeleteFavorites200ResponseData](docs/DeleteFavorites200ResponseData.md)
|
|
268
|
+
- [SparteraApiSdk::DeletePostgenIntegrations200Response](docs/DeletePostgenIntegrations200Response.md)
|
|
269
|
+
- [SparteraApiSdk::DeletePostgenIntegrations200ResponseData](docs/DeletePostgenIntegrations200ResponseData.md)
|
|
270
|
+
- [SparteraApiSdk::DeletePosts200Response](docs/DeletePosts200Response.md)
|
|
271
|
+
- [SparteraApiSdk::DeletePosts200ResponseData](docs/DeletePosts200ResponseData.md)
|
|
272
|
+
- [SparteraApiSdk::DeleteUsers200Response](docs/DeleteUsers200Response.md)
|
|
273
|
+
- [SparteraApiSdk::DeleteUsers200ResponseData](docs/DeleteUsers200ResponseData.md)
|
|
274
|
+
- [SparteraApiSdk::Endpoints](docs/Endpoints.md)
|
|
275
|
+
- [SparteraApiSdk::EndpointsInput](docs/EndpointsInput.md)
|
|
276
|
+
- [SparteraApiSdk::EndpointsUpdate](docs/EndpointsUpdate.md)
|
|
277
|
+
- [SparteraApiSdk::Error](docs/Error.md)
|
|
278
|
+
- [SparteraApiSdk::Favorites](docs/Favorites.md)
|
|
279
|
+
- [SparteraApiSdk::FavoritesInput](docs/FavoritesInput.md)
|
|
280
|
+
- [SparteraApiSdk::FavoritesUpdate](docs/FavoritesUpdate.md)
|
|
281
|
+
- [SparteraApiSdk::GetAlertsById200Response](docs/GetAlertsById200Response.md)
|
|
282
|
+
- [SparteraApiSdk::GetApiKeysById200Response](docs/GetApiKeysById200Response.md)
|
|
283
|
+
- [SparteraApiSdk::GetAssetPriceHistoryById200Response](docs/GetAssetPriceHistoryById200Response.md)
|
|
284
|
+
- [SparteraApiSdk::GetAssetUsecasesById200Response](docs/GetAssetUsecasesById200Response.md)
|
|
285
|
+
- [SparteraApiSdk::GetAssetsByIdAnalyze200Response](docs/GetAssetsByIdAnalyze200Response.md)
|
|
286
|
+
- [SparteraApiSdk::GetCloudProvidersById200Response](docs/GetCloudProvidersById200Response.md)
|
|
287
|
+
- [SparteraApiSdk::GetCompaniesById200Response](docs/GetCompaniesById200Response.md)
|
|
288
|
+
- [SparteraApiSdk::GetConnectionsById200Response](docs/GetConnectionsById200Response.md)
|
|
289
|
+
- [SparteraApiSdk::GetEndpointsByIdConnectionsDescribe200Response](docs/GetEndpointsByIdConnectionsDescribe200Response.md)
|
|
290
|
+
- [SparteraApiSdk::GetFavoritesById200Response](docs/GetFavoritesById200Response.md)
|
|
291
|
+
- [SparteraApiSdk::GetIndustriesById200Response](docs/GetIndustriesById200Response.md)
|
|
292
|
+
- [SparteraApiSdk::GetJobFunctionsById200Response](docs/GetJobFunctionsById200Response.md)
|
|
293
|
+
- [SparteraApiSdk::GetPostgenIntegrationsById200Response](docs/GetPostgenIntegrationsById200Response.md)
|
|
294
|
+
- [SparteraApiSdk::GetPostsById200Response](docs/GetPostsById200Response.md)
|
|
295
|
+
- [SparteraApiSdk::GetStorageEnginesById200Response](docs/GetStorageEnginesById200Response.md)
|
|
296
|
+
- [SparteraApiSdk::GetUsersById200Response](docs/GetUsersById200Response.md)
|
|
297
|
+
- [SparteraApiSdk::Industries](docs/Industries.md)
|
|
298
|
+
- [SparteraApiSdk::InlineObject](docs/InlineObject.md)
|
|
299
|
+
- [SparteraApiSdk::InlineObject1](docs/InlineObject1.md)
|
|
300
|
+
- [SparteraApiSdk::InlineObject2](docs/InlineObject2.md)
|
|
301
|
+
- [SparteraApiSdk::InlineObject3](docs/InlineObject3.md)
|
|
302
|
+
- [SparteraApiSdk::InlineObject4](docs/InlineObject4.md)
|
|
303
|
+
- [SparteraApiSdk::InlineObject5](docs/InlineObject5.md)
|
|
304
|
+
- [SparteraApiSdk::InlineObject6](docs/InlineObject6.md)
|
|
305
|
+
- [SparteraApiSdk::InlineObject7](docs/InlineObject7.md)
|
|
306
|
+
- [SparteraApiSdk::JobFunctions](docs/JobFunctions.md)
|
|
307
|
+
- [SparteraApiSdk::JobFunctionsInput](docs/JobFunctionsInput.md)
|
|
308
|
+
- [SparteraApiSdk::JobFunctionsUpdate](docs/JobFunctionsUpdate.md)
|
|
309
|
+
- [SparteraApiSdk::ListApiKeys200Response](docs/ListApiKeys200Response.md)
|
|
310
|
+
- [SparteraApiSdk::ListAssetUsecases200Response](docs/ListAssetUsecases200Response.md)
|
|
311
|
+
- [SparteraApiSdk::ListAssets200Response](docs/ListAssets200Response.md)
|
|
312
|
+
- [SparteraApiSdk::ListCloudProviders200Response](docs/ListCloudProviders200Response.md)
|
|
313
|
+
- [SparteraApiSdk::ListCompaniesAnalyticsAssets200Response](docs/ListCompaniesAnalyticsAssets200Response.md)
|
|
314
|
+
- [SparteraApiSdk::ListConnections200Response](docs/ListConnections200Response.md)
|
|
315
|
+
- [SparteraApiSdk::ListEndpoints200Response](docs/ListEndpoints200Response.md)
|
|
316
|
+
- [SparteraApiSdk::ListIndustries200Response](docs/ListIndustries200Response.md)
|
|
317
|
+
- [SparteraApiSdk::ListJobFunctions200Response](docs/ListJobFunctions200Response.md)
|
|
318
|
+
- [SparteraApiSdk::ListPostgenIntegrations200Response](docs/ListPostgenIntegrations200Response.md)
|
|
319
|
+
- [SparteraApiSdk::ListPosts200Response](docs/ListPosts200Response.md)
|
|
320
|
+
- [SparteraApiSdk::ListStorageEngines200Response](docs/ListStorageEngines200Response.md)
|
|
321
|
+
- [SparteraApiSdk::ListUsers200Response](docs/ListUsers200Response.md)
|
|
322
|
+
- [SparteraApiSdk::PostPublications](docs/PostPublications.md)
|
|
323
|
+
- [SparteraApiSdk::PostPublicationsInput](docs/PostPublicationsInput.md)
|
|
324
|
+
- [SparteraApiSdk::PostPublicationsUpdate](docs/PostPublicationsUpdate.md)
|
|
325
|
+
- [SparteraApiSdk::PostgenIntegrations](docs/PostgenIntegrations.md)
|
|
326
|
+
- [SparteraApiSdk::PostgenIntegrationsInput](docs/PostgenIntegrationsInput.md)
|
|
327
|
+
- [SparteraApiSdk::PostgenIntegrationsUpdate](docs/PostgenIntegrationsUpdate.md)
|
|
328
|
+
- [SparteraApiSdk::Posts](docs/Posts.md)
|
|
329
|
+
- [SparteraApiSdk::PostsInput](docs/PostsInput.md)
|
|
330
|
+
- [SparteraApiSdk::PostsUpdate](docs/PostsUpdate.md)
|
|
331
|
+
- [SparteraApiSdk::StorageEngines](docs/StorageEngines.md)
|
|
332
|
+
- [SparteraApiSdk::UpdateAlerts200Response](docs/UpdateAlerts200Response.md)
|
|
333
|
+
- [SparteraApiSdk::UpdateAlerts200ResponseData](docs/UpdateAlerts200ResponseData.md)
|
|
334
|
+
- [SparteraApiSdk::UpdateApiKeys200Response](docs/UpdateApiKeys200Response.md)
|
|
335
|
+
- [SparteraApiSdk::UpdateApiKeys200ResponseData](docs/UpdateApiKeys200ResponseData.md)
|
|
336
|
+
- [SparteraApiSdk::UpdateAssetPriceHistory200Response](docs/UpdateAssetPriceHistory200Response.md)
|
|
337
|
+
- [SparteraApiSdk::UpdateAssetPriceHistory200ResponseData](docs/UpdateAssetPriceHistory200ResponseData.md)
|
|
338
|
+
- [SparteraApiSdk::UpdateAssets200Response](docs/UpdateAssets200Response.md)
|
|
339
|
+
- [SparteraApiSdk::UpdateAssets200ResponseData](docs/UpdateAssets200ResponseData.md)
|
|
340
|
+
- [SparteraApiSdk::UpdateCompanies200Response](docs/UpdateCompanies200Response.md)
|
|
341
|
+
- [SparteraApiSdk::UpdateCompanies200ResponseData](docs/UpdateCompanies200ResponseData.md)
|
|
342
|
+
- [SparteraApiSdk::UpdateConnections200Response](docs/UpdateConnections200Response.md)
|
|
343
|
+
- [SparteraApiSdk::UpdateConnections200ResponseData](docs/UpdateConnections200ResponseData.md)
|
|
344
|
+
- [SparteraApiSdk::UpdateEndpoints200Response](docs/UpdateEndpoints200Response.md)
|
|
345
|
+
- [SparteraApiSdk::UpdateEndpoints200ResponseData](docs/UpdateEndpoints200ResponseData.md)
|
|
346
|
+
- [SparteraApiSdk::UpdateFavorites200Response](docs/UpdateFavorites200Response.md)
|
|
347
|
+
- [SparteraApiSdk::UpdateFavorites200ResponseData](docs/UpdateFavorites200ResponseData.md)
|
|
348
|
+
- [SparteraApiSdk::UpdatePostgenIntegrations200Response](docs/UpdatePostgenIntegrations200Response.md)
|
|
349
|
+
- [SparteraApiSdk::UpdatePostgenIntegrations200ResponseData](docs/UpdatePostgenIntegrations200ResponseData.md)
|
|
350
|
+
- [SparteraApiSdk::UpdatePosts200Response](docs/UpdatePosts200Response.md)
|
|
351
|
+
- [SparteraApiSdk::UpdatePosts200ResponseData](docs/UpdatePosts200ResponseData.md)
|
|
352
|
+
- [SparteraApiSdk::UpdateUsers200Response](docs/UpdateUsers200Response.md)
|
|
353
|
+
- [SparteraApiSdk::UpdateUsers200ResponseData](docs/UpdateUsers200ResponseData.md)
|
|
354
|
+
- [SparteraApiSdk::Users](docs/Users.md)
|
|
355
|
+
- [SparteraApiSdk::UsersInput](docs/UsersInput.md)
|
|
356
|
+
- [SparteraApiSdk::UsersUpdate](docs/UsersUpdate.md)
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
## Documentation for Authorization
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
Authentication schemes defined for the API:
|
|
363
|
+
### ApiKeyAuth
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
- **Type**: API key
|
|
367
|
+
- **API key parameter name**: x-api-key
|
|
368
|
+
- **Location**: HTTP header
|
|
356
369
|
|
|
357
|
-
## Publishing
|
|
358
|
-
1. Build: `gem build *.gemspec`
|
|
359
|
-
2. Push: `gem push *.gem`
|
|
360
|
-
3. Install: `gem install spartera_api_sdk`
|