spartera_api_sdk 0.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +9 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +372 -0
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +537 -0
- data/docs/Alerts.md +30 -0
- data/docs/AlertsApi.md +525 -0
- data/docs/AlertsInput.md +24 -0
- data/docs/AlertsUpdate.md +24 -0
- data/docs/ApiKeys.md +40 -0
- data/docs/ApiKeysInput.md +34 -0
- data/docs/ApiKeysUpdate.md +34 -0
- data/docs/AssetPriceHistory.md +30 -0
- data/docs/AssetPriceHistoryApi.md +597 -0
- data/docs/AssetPriceHistoryInput.md +24 -0
- data/docs/AssetPriceHistoryUpdate.md +24 -0
- data/docs/AssetUsecases.md +28 -0
- data/docs/AssetUsecasesApi.md +157 -0
- data/docs/Assets.md +142 -0
- data/docs/AssetsApi.md +1197 -0
- data/docs/AssetsInput.md +128 -0
- data/docs/AssetsUpdate.md +128 -0
- data/docs/CloudProviders.md +28 -0
- data/docs/CloudProvidersApi.md +157 -0
- data/docs/CloudProvidersInput.md +22 -0
- data/docs/CloudProvidersUpdate.md +22 -0
- data/docs/Companies.md +46 -0
- data/docs/CompaniesApi.md +805 -0
- data/docs/CompaniesInput.md +40 -0
- data/docs/CompaniesUpdate.md +40 -0
- data/docs/Connections.md +38 -0
- data/docs/ConnectionsApi.md +607 -0
- data/docs/ConnectionsInput.md +32 -0
- data/docs/ConnectionsUpdate.md +32 -0
- data/docs/CreateAlerts200Response.md +20 -0
- data/docs/CreateAlerts200ResponseData.md +18 -0
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/CreateApiKeys200ResponseData.md +18 -0
- data/docs/CreateAssetPriceHistory200Response.md +20 -0
- data/docs/CreateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/CreateAssetsAnalyze200Response.md +20 -0
- data/docs/CreateAssetsAnalyze200ResponseData.md +18 -0
- data/docs/CreateConnections200Response.md +20 -0
- data/docs/CreateConnections200ResponseData.md +18 -0
- data/docs/CreateEndpoints200Response.md +20 -0
- data/docs/CreateEndpoints200ResponseData.md +18 -0
- data/docs/CreateFavorites200Response.md +20 -0
- data/docs/CreateFavorites200ResponseData.md +18 -0
- data/docs/CreatePostgenIntegrations200Response.md +20 -0
- data/docs/CreatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/CreatePosts200Response.md +20 -0
- data/docs/CreatePosts200ResponseData.md +18 -0
- data/docs/CreateUsers200Response.md +20 -0
- data/docs/CreateUsers200ResponseData.md +18 -0
- data/docs/DeleteAlerts200Response.md +20 -0
- data/docs/DeleteAlerts200ResponseData.md +18 -0
- data/docs/DeleteApiKeys200Response.md +20 -0
- data/docs/DeleteApiKeys200ResponseData.md +18 -0
- data/docs/DeleteAssetPriceHistory200Response.md +20 -0
- data/docs/DeleteAssetPriceHistory200ResponseData.md +18 -0
- data/docs/DeleteAssets200Response.md +20 -0
- data/docs/DeleteAssets200ResponseData.md +18 -0
- data/docs/DeleteConnections200Response.md +20 -0
- data/docs/DeleteConnections200ResponseData.md +18 -0
- data/docs/DeleteEndpoints200Response.md +20 -0
- data/docs/DeleteEndpoints200ResponseData.md +18 -0
- data/docs/DeleteFavorites200Response.md +20 -0
- data/docs/DeleteFavorites200ResponseData.md +18 -0
- data/docs/DeletePostgenIntegrations200Response.md +20 -0
- data/docs/DeletePostgenIntegrations200ResponseData.md +18 -0
- data/docs/DeletePosts200Response.md +20 -0
- data/docs/DeletePosts200ResponseData.md +18 -0
- data/docs/DeleteUsers200Response.md +20 -0
- data/docs/DeleteUsers200ResponseData.md +18 -0
- data/docs/Endpoints.md +96 -0
- data/docs/EndpointsApi.md +1189 -0
- data/docs/EndpointsInput.md +94 -0
- data/docs/EndpointsUpdate.md +94 -0
- data/docs/Error.md +24 -0
- data/docs/Favorites.md +34 -0
- data/docs/FavoritesApi.md +597 -0
- data/docs/FavoritesInput.md +28 -0
- data/docs/FavoritesUpdate.md +28 -0
- data/docs/GetAlertsById200Response.md +20 -0
- data/docs/GetApiKeysById200Response.md +20 -0
- data/docs/GetAssetPriceHistoryById200Response.md +20 -0
- data/docs/GetAssetUsecasesById200Response.md +20 -0
- data/docs/GetAssetsByIdAnalyze200Response.md +20 -0
- data/docs/GetCloudProvidersById200Response.md +20 -0
- data/docs/GetCompaniesById200Response.md +20 -0
- data/docs/GetConnectionsById200Response.md +20 -0
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
- data/docs/GetFavoritesById200Response.md +20 -0
- data/docs/GetIndustriesById200Response.md +20 -0
- data/docs/GetJobFunctionsById200Response.md +20 -0
- data/docs/GetPostgenIntegrationsById200Response.md +20 -0
- data/docs/GetPostsById200Response.md +20 -0
- data/docs/GetStorageEnginesById200Response.md +20 -0
- data/docs/GetUsersById200Response.md +20 -0
- data/docs/Industries.md +32 -0
- data/docs/IndustriesApi.md +237 -0
- data/docs/InlineObject.md +22 -0
- data/docs/InlineObject1.md +20 -0
- data/docs/InlineObject2.md +20 -0
- data/docs/InlineObject3.md +20 -0
- data/docs/InlineObject4.md +20 -0
- data/docs/InlineObject5.md +20 -0
- data/docs/InlineObject6.md +22 -0
- data/docs/InlineObject7.md +20 -0
- data/docs/JobFunctions.md +24 -0
- data/docs/JobFunctionsApi.md +157 -0
- data/docs/JobFunctionsInput.md +18 -0
- data/docs/JobFunctionsUpdate.md +18 -0
- data/docs/ListApiKeys200Response.md +20 -0
- data/docs/ListAssetUsecases200Response.md +20 -0
- data/docs/ListAssets200Response.md +20 -0
- data/docs/ListCloudProviders200Response.md +20 -0
- data/docs/ListCompaniesAnalyticsAssets200Response.md +20 -0
- data/docs/ListConnections200Response.md +20 -0
- data/docs/ListEndpoints200Response.md +20 -0
- data/docs/ListIndustries200Response.md +20 -0
- data/docs/ListJobFunctions200Response.md +20 -0
- data/docs/ListPostgenIntegrations200Response.md +20 -0
- data/docs/ListPosts200Response.md +20 -0
- data/docs/ListStorageEngines200Response.md +20 -0
- data/docs/ListUsers200Response.md +20 -0
- data/docs/PostPublications.md +40 -0
- data/docs/PostPublicationsInput.md +34 -0
- data/docs/PostPublicationsUpdate.md +34 -0
- data/docs/PostgenIntegrations.md +36 -0
- data/docs/PostgenIntegrationsApi.md +463 -0
- data/docs/PostgenIntegrationsInput.md +30 -0
- data/docs/PostgenIntegrationsUpdate.md +30 -0
- data/docs/Posts.md +68 -0
- data/docs/PostsApi.md +843 -0
- data/docs/PostsInput.md +62 -0
- data/docs/PostsUpdate.md +62 -0
- data/docs/StorageEngines.md +32 -0
- data/docs/StorageEnginesApi.md +161 -0
- data/docs/UpdateAlerts200Response.md +20 -0
- data/docs/UpdateAlerts200ResponseData.md +18 -0
- data/docs/UpdateApiKeys200Response.md +20 -0
- data/docs/UpdateApiKeys200ResponseData.md +18 -0
- data/docs/UpdateAssetPriceHistory200Response.md +20 -0
- data/docs/UpdateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/UpdateAssets200Response.md +20 -0
- data/docs/UpdateAssets200ResponseData.md +18 -0
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/UpdateCompanies200ResponseData.md +18 -0
- data/docs/UpdateConnections200Response.md +20 -0
- data/docs/UpdateConnections200ResponseData.md +18 -0
- data/docs/UpdateEndpoints200Response.md +20 -0
- data/docs/UpdateEndpoints200ResponseData.md +18 -0
- data/docs/UpdateFavorites200Response.md +20 -0
- data/docs/UpdateFavorites200ResponseData.md +18 -0
- data/docs/UpdatePostgenIntegrations200Response.md +20 -0
- data/docs/UpdatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/UpdatePosts200Response.md +20 -0
- data/docs/UpdatePosts200ResponseData.md +18 -0
- data/docs/UpdateUsers200Response.md +20 -0
- data/docs/UpdateUsers200ResponseData.md +18 -0
- data/docs/Users.md +36 -0
- data/docs/UsersApi.md +639 -0
- data/docs/UsersInput.md +30 -0
- data/docs/UsersUpdate.md +30 -0
- data/git_push.sh +57 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +790 -0
- data/lib/spartera_api_sdk/api/api_keys_api.rb +746 -0
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +867 -0
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +1554 -0
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +190 -0
- data/lib/spartera_api_sdk/api/companies_api.rb +1085 -0
- data/lib/spartera_api_sdk/api/connections_api.rb +828 -0
- data/lib/spartera_api_sdk/api/endpoints_api.rb +1613 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +870 -0
- data/lib/spartera_api_sdk/api/industries_api.rb +284 -0
- data/lib/spartera_api_sdk/api/job_functions_api.rb +190 -0
- data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +634 -0
- data/lib/spartera_api_sdk/api/posts_api.rb +1190 -0
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +228 -0
- data/lib/spartera_api_sdk/api/users_api.rb +891 -0
- data/lib/spartera_api_sdk/api_client.rb +397 -0
- data/lib/spartera_api_sdk/api_error.rb +58 -0
- data/lib/spartera_api_sdk/api_model_base.rb +88 -0
- data/lib/spartera_api_sdk/configuration.rb +312 -0
- data/lib/spartera_api_sdk/models/alerts.rb +260 -0
- data/lib/spartera_api_sdk/models/alerts_input.rb +213 -0
- data/lib/spartera_api_sdk/models/alerts_update.rb +179 -0
- data/lib/spartera_api_sdk/models/api_keys.rb +344 -0
- data/lib/spartera_api_sdk/models/api_keys_input.rb +263 -0
- data/lib/spartera_api_sdk/models/api_keys_update.rb +229 -0
- data/lib/spartera_api_sdk/models/asset_price_history.rb +209 -0
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
- data/lib/spartera_api_sdk/models/assets.rb +1068 -0
- data/lib/spartera_api_sdk/models/assets_input.rb +918 -0
- data/lib/spartera_api_sdk/models/assets_update.rb +877 -0
- data/lib/spartera_api_sdk/models/cloud_providers.rb +216 -0
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +186 -0
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +169 -0
- data/lib/spartera_api_sdk/models/companies.rb +374 -0
- data/lib/spartera_api_sdk/models/companies_input.rb +327 -0
- data/lib/spartera_api_sdk/models/companies_update.rb +293 -0
- data/lib/spartera_api_sdk/models/connections.rb +317 -0
- data/lib/spartera_api_sdk/models/connections_input.rb +287 -0
- data/lib/spartera_api_sdk/models/connections_update.rb +253 -0
- data/lib/spartera_api_sdk/models/create_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_alerts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_connections200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_favorites200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_users200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_alerts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_assets200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_connections200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_favorites200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_users200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/endpoints.rb +788 -0
- data/lib/spartera_api_sdk/models/endpoints_input.rb +686 -0
- data/lib/spartera_api_sdk/models/endpoints_update.rb +635 -0
- data/lib/spartera_api_sdk/models/error.rb +212 -0
- data/lib/spartera_api_sdk/models/favorites.rb +280 -0
- data/lib/spartera_api_sdk/models/favorites_input.rb +233 -0
- data/lib/spartera_api_sdk/models/favorites_update.rb +199 -0
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_endpoints_by_id_connections_describe200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_postgen_integrations_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/industries.rb +253 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +167 -0
- data/lib/spartera_api_sdk/models/inline_object1.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object2.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object3.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object4.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object5.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object6.rb +166 -0
- data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
- data/lib/spartera_api_sdk/models/job_functions.rb +213 -0
- data/lib/spartera_api_sdk/models/job_functions_input.rb +166 -0
- data/lib/spartera_api_sdk/models/job_functions_update.rb +149 -0
- data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_asset_usecases200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_assets200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_companies_analytics_assets200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_connections200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_industries200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_posts200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_users200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/post_publications.rb +327 -0
- data/lib/spartera_api_sdk/models/post_publications_input.rb +280 -0
- data/lib/spartera_api_sdk/models/post_publications_update.rb +229 -0
- data/lib/spartera_api_sdk/models/postgen_integrations.rb +341 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +294 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +209 -0
- data/lib/spartera_api_sdk/models/posts.rb +586 -0
- data/lib/spartera_api_sdk/models/posts_input.rb +437 -0
- data/lib/spartera_api_sdk/models/posts_update.rb +369 -0
- data/lib/spartera_api_sdk/models/storage_engines.rb +294 -0
- data/lib/spartera_api_sdk/models/update_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_alerts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_assets200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_companies200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_connections200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_favorites200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_users200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/users.rb +331 -0
- data/lib/spartera_api_sdk/models/users_input.rb +260 -0
- data/lib/spartera_api_sdk/models/users_update.rb +243 -0
- data/lib/spartera_api_sdk/version.rb +15 -0
- data/lib/spartera_api_sdk.rb +201 -0
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +126 -0
- data/spec/api/api_keys_api_spec.rb +130 -0
- data/spec/api/asset_price_history_api_spec.rb +138 -0
- data/spec/api/asset_usecases_api_spec.rb +61 -0
- data/spec/api/assets_api_spec.rb +243 -0
- data/spec/api/cloud_providers_api_spec.rb +61 -0
- data/spec/api/companies_api_spec.rb +186 -0
- data/spec/api/connections_api_spec.rb +141 -0
- data/spec/api/endpoints_api_spec.rb +240 -0
- data/spec/api/favorites_api_spec.rb +138 -0
- data/spec/api/industries_api_spec.rb +76 -0
- data/spec/api/job_functions_api_spec.rb +61 -0
- data/spec/api/postgen_integrations_api_spec.rb +117 -0
- data/spec/api/posts_api_spec.rb +186 -0
- data/spec/api/storage_engines_api_spec.rb +63 -0
- data/spec/api/users_api_spec.rb +154 -0
- data/spec/models/alerts_input_spec.rb +54 -0
- data/spec/models/alerts_spec.rb +72 -0
- data/spec/models/alerts_update_spec.rb +54 -0
- data/spec/models/api_keys_input_spec.rb +84 -0
- data/spec/models/api_keys_spec.rb +102 -0
- data/spec/models/api_keys_update_spec.rb +84 -0
- data/spec/models/asset_price_history_input_spec.rb +54 -0
- data/spec/models/asset_price_history_spec.rb +72 -0
- data/spec/models/asset_price_history_update_spec.rb +54 -0
- data/spec/models/asset_usecases_spec.rb +66 -0
- data/spec/models/assets_input_spec.rb +418 -0
- data/spec/models/assets_spec.rb +464 -0
- data/spec/models/assets_update_spec.rb +418 -0
- data/spec/models/cloud_providers_input_spec.rb +48 -0
- data/spec/models/cloud_providers_spec.rb +66 -0
- data/spec/models/cloud_providers_update_spec.rb +48 -0
- data/spec/models/companies_input_spec.rb +106 -0
- data/spec/models/companies_spec.rb +124 -0
- data/spec/models/companies_update_spec.rb +106 -0
- data/spec/models/connections_input_spec.rb +82 -0
- data/spec/models/connections_spec.rb +100 -0
- data/spec/models/connections_update_spec.rb +82 -0
- data/spec/models/create_alerts200_response_data_spec.rb +36 -0
- data/spec/models/create_alerts200_response_spec.rb +42 -0
- data/spec/models/create_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/create_api_keys200_response_spec.rb +42 -0
- data/spec/models/create_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/create_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/create_assets_analyze200_response_data_spec.rb +36 -0
- data/spec/models/create_assets_analyze200_response_spec.rb +42 -0
- data/spec/models/create_connections200_response_data_spec.rb +36 -0
- data/spec/models/create_connections200_response_spec.rb +42 -0
- data/spec/models/create_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/create_endpoints200_response_spec.rb +42 -0
- data/spec/models/create_favorites200_response_data_spec.rb +36 -0
- data/spec/models/create_favorites200_response_spec.rb +42 -0
- data/spec/models/create_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/create_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/create_posts200_response_data_spec.rb +36 -0
- data/spec/models/create_posts200_response_spec.rb +42 -0
- data/spec/models/create_users200_response_data_spec.rb +36 -0
- data/spec/models/create_users200_response_spec.rb +42 -0
- data/spec/models/delete_alerts200_response_data_spec.rb +36 -0
- data/spec/models/delete_alerts200_response_spec.rb +42 -0
- data/spec/models/delete_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/delete_api_keys200_response_spec.rb +42 -0
- data/spec/models/delete_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/delete_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/delete_assets200_response_data_spec.rb +36 -0
- data/spec/models/delete_assets200_response_spec.rb +42 -0
- data/spec/models/delete_connections200_response_data_spec.rb +36 -0
- data/spec/models/delete_connections200_response_spec.rb +42 -0
- data/spec/models/delete_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/delete_endpoints200_response_spec.rb +42 -0
- data/spec/models/delete_favorites200_response_data_spec.rb +36 -0
- data/spec/models/delete_favorites200_response_spec.rb +42 -0
- data/spec/models/delete_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/delete_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/delete_posts200_response_data_spec.rb +36 -0
- data/spec/models/delete_posts200_response_spec.rb +42 -0
- data/spec/models/delete_users200_response_data_spec.rb +36 -0
- data/spec/models/delete_users200_response_spec.rb +42 -0
- data/spec/models/endpoints_input_spec.rb +292 -0
- data/spec/models/endpoints_spec.rb +298 -0
- data/spec/models/endpoints_update_spec.rb +292 -0
- data/spec/models/error_spec.rb +54 -0
- data/spec/models/favorites_input_spec.rb +66 -0
- data/spec/models/favorites_spec.rb +84 -0
- data/spec/models/favorites_update_spec.rb +66 -0
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/get_api_keys_by_id200_response_spec.rb +42 -0
- data/spec/models/get_asset_price_history_by_id200_response_spec.rb +42 -0
- data/spec/models/get_asset_usecases_by_id200_response_spec.rb +42 -0
- data/spec/models/get_assets_by_id_analyze200_response_spec.rb +42 -0
- data/spec/models/get_cloud_providers_by_id200_response_spec.rb +42 -0
- data/spec/models/get_companies_by_id200_response_spec.rb +42 -0
- data/spec/models/get_connections_by_id200_response_spec.rb +42 -0
- data/spec/models/get_endpoints_by_id_connections_describe200_response_spec.rb +42 -0
- data/spec/models/get_favorites_by_id200_response_spec.rb +42 -0
- data/spec/models/get_industries_by_id200_response_spec.rb +42 -0
- data/spec/models/get_job_functions_by_id200_response_spec.rb +42 -0
- data/spec/models/get_postgen_integrations_by_id200_response_spec.rb +42 -0
- data/spec/models/get_posts_by_id200_response_spec.rb +42 -0
- data/spec/models/get_storage_engines_by_id200_response_spec.rb +42 -0
- data/spec/models/get_users_by_id200_response_spec.rb +42 -0
- data/spec/models/industries_spec.rb +78 -0
- data/spec/models/inline_object1_spec.rb +42 -0
- data/spec/models/inline_object2_spec.rb +42 -0
- data/spec/models/inline_object3_spec.rb +42 -0
- data/spec/models/inline_object4_spec.rb +42 -0
- data/spec/models/inline_object5_spec.rb +42 -0
- data/spec/models/inline_object6_spec.rb +48 -0
- data/spec/models/inline_object7_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +48 -0
- data/spec/models/job_functions_input_spec.rb +36 -0
- data/spec/models/job_functions_spec.rb +54 -0
- data/spec/models/job_functions_update_spec.rb +36 -0
- data/spec/models/list_api_keys200_response_spec.rb +42 -0
- data/spec/models/list_asset_usecases200_response_spec.rb +42 -0
- data/spec/models/list_assets200_response_spec.rb +42 -0
- data/spec/models/list_cloud_providers200_response_spec.rb +42 -0
- data/spec/models/list_companies_analytics_assets200_response_spec.rb +42 -0
- data/spec/models/list_connections200_response_spec.rb +42 -0
- data/spec/models/list_endpoints200_response_spec.rb +42 -0
- data/spec/models/list_industries200_response_spec.rb +42 -0
- data/spec/models/list_job_functions200_response_spec.rb +42 -0
- data/spec/models/list_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/list_posts200_response_spec.rb +42 -0
- data/spec/models/list_storage_engines200_response_spec.rb +42 -0
- data/spec/models/list_users200_response_spec.rb +42 -0
- data/spec/models/post_publications_input_spec.rb +84 -0
- data/spec/models/post_publications_spec.rb +102 -0
- data/spec/models/post_publications_update_spec.rb +84 -0
- data/spec/models/postgen_integrations_input_spec.rb +72 -0
- data/spec/models/postgen_integrations_spec.rb +90 -0
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/posts_input_spec.rb +168 -0
- data/spec/models/posts_spec.rb +186 -0
- data/spec/models/posts_update_spec.rb +168 -0
- data/spec/models/storage_engines_spec.rb +82 -0
- data/spec/models/update_alerts200_response_data_spec.rb +36 -0
- data/spec/models/update_alerts200_response_spec.rb +42 -0
- data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/update_api_keys200_response_spec.rb +42 -0
- data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/update_assets200_response_data_spec.rb +36 -0
- data/spec/models/update_assets200_response_spec.rb +42 -0
- data/spec/models/update_companies200_response_data_spec.rb +36 -0
- data/spec/models/update_companies200_response_spec.rb +42 -0
- data/spec/models/update_connections200_response_data_spec.rb +36 -0
- data/spec/models/update_connections200_response_spec.rb +42 -0
- data/spec/models/update_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/update_endpoints200_response_spec.rb +42 -0
- data/spec/models/update_favorites200_response_data_spec.rb +36 -0
- data/spec/models/update_favorites200_response_spec.rb +42 -0
- data/spec/models/update_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/update_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/update_posts200_response_data_spec.rb +36 -0
- data/spec/models/update_posts200_response_spec.rb +42 -0
- data/spec/models/update_users200_response_data_spec.rb +36 -0
- data/spec/models/update_users200_response_spec.rb +42 -0
- data/spec/models/users_input_spec.rb +76 -0
- data/spec/models/users_spec.rb +94 -0
- data/spec/models/users_update_spec.rb +76 -0
- data/spec/spec_helper.rb +111 -0
- metadata +742 -0
data/docs/AssetsInput.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# SparteraApiSdk::AssetsInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
|
|
8
|
+
| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | |
|
|
9
|
+
| **connection_id** | **String** | Optional. | [optional] |
|
|
10
|
+
| **industry_id** | **Integer** | References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional. | [optional] |
|
|
11
|
+
| **auc_id** | **Integer** | Primary use case for this asset, from clustering analysis | [optional] |
|
|
12
|
+
| **function_id** | **String** | Optional identifier for routing to specific functions/models at seller endpoint. For GET: appended to URL path. For POST: included in JSON body. | [optional] |
|
|
13
|
+
| **approval_status** | **String** | Approval status for AI-generated assets | [optional] |
|
|
14
|
+
| **approved_by_user_id** | **String** | User who approved this asset for marketplace | [optional] |
|
|
15
|
+
| **approved_at** | **Time** | When this asset was approved for marketplace | [optional] |
|
|
16
|
+
| **name** | **String** | Required. | |
|
|
17
|
+
| **slug** | **String** | Optional. | [optional] |
|
|
18
|
+
| **description** | **String** | Optional. | [optional] |
|
|
19
|
+
| **detailed_description** | **String** | Long-form HTML description for product pages and SEO | [optional] |
|
|
20
|
+
| **source** | **String** | Required. One of: MANUAL, AUTOMATIC. | |
|
|
21
|
+
| **asset_type** | **String** | Optional. One of: CALCULATION, VISUALIZATION, DATA. | [optional] |
|
|
22
|
+
| **asset_schema** | **Object** | Stores database table schema data including columns, types, and metadata | [optional] |
|
|
23
|
+
| **tags** | **String** | Optional. | [optional] |
|
|
24
|
+
| **top_questions** | **String** | Top 3 questions this asset can help answer, in English. Stored as JSON array of strings (1-3 items, 15-200 chars each). Required for marketplace assets. | [optional] |
|
|
25
|
+
| **short_code** | **String** | Short code for tera.ac URL shortener (e.g., 'f78zq1') | [optional] |
|
|
26
|
+
| **restricted_domains** | **String** | Semicolon or comma-separated list of domains restricted from accessing this asset | [optional] |
|
|
27
|
+
| **sql_logic** | **String** | Optional. | [optional] |
|
|
28
|
+
| **source_schema_name** | **String** | Optional. | [optional] |
|
|
29
|
+
| **source_table_name** | **String** | Optional. | [optional] |
|
|
30
|
+
| **sell_in_marketplace** | **Boolean** | Required. | [optional] |
|
|
31
|
+
| **require_customization** | **Boolean** | Whether this asset requires customization before use | [optional] |
|
|
32
|
+
| **viz_spec** | **Object** | Plotly figure JSON describing the visualization. Authored via the visual editor or via API. When populated, takes precedence over the legacy viz_* fields. Shape follows Plotly's figure schema: {data: [{type: '...', xsrc: '...', ...}], layout: {...}}. Column references use *src keys (xsrc, ysrc, labelssrc, etc.) and are hydrated with actual data at render time. | [optional] |
|
|
33
|
+
| **viz_chart_library** | **String** | Optional. One of: PLOTLY, MATPLOTLIB, SEABORN. | [optional] |
|
|
34
|
+
| **viz_chart_type** | **String** | Optional. One of: LINE, BAR, PIE, DOUGHNUT, POLAR, … (8 total). | [optional] |
|
|
35
|
+
| **viz_dep_var_col_name** | **String** | Optional. | [optional] |
|
|
36
|
+
| **viz_indep_var_col_name** | **String** | Optional. | [optional] |
|
|
37
|
+
| **viz_size_col_name** | **String** | Optional. | [optional] |
|
|
38
|
+
| **viz_color_col_name** | **String** | Optional. | [optional] |
|
|
39
|
+
| **viz_data_aggregation** | **String** | Optional. One of: No Aggregation, Sum, Average, Count, Minimum, … (6 total). | [optional] |
|
|
40
|
+
| **viz_sort_direction** | **String** | Optional. One of: No Sorting, Ascending, Descending. | [optional] |
|
|
41
|
+
| **viz_data_limit** | **Integer** | Optional. | [optional] |
|
|
42
|
+
| **viz_color_scheme** | **String** | Optional. One of: Default, Sequential, Diverging, Categorical, Monochrome, … (8 total). | [optional] |
|
|
43
|
+
| **viz_show_legend** | **Boolean** | Show/hide chart legend | [optional] |
|
|
44
|
+
| **viz_show_grid** | **Boolean** | Show/hide grid lines | [optional] |
|
|
45
|
+
| **viz_show_trendline** | **Boolean** | Show trendline for scatter/line charts | [optional] |
|
|
46
|
+
| **viz_line_smoothing** | **Boolean** | Enable smoothing for line charts | [optional] |
|
|
47
|
+
| **viz_bar_stacked** | **Boolean** | Stack bars instead of grouping | [optional] |
|
|
48
|
+
| **viz_filter_direction** | **String** | Whether data_limit shows TOP or BOTTOM N | [optional] |
|
|
49
|
+
| **allow_params** | **Boolean** | Required. | [optional] |
|
|
50
|
+
| **accept_terms** | **Boolean** | Required. | [optional] |
|
|
51
|
+
| **cached** | **Boolean** | Optional. | [optional] |
|
|
52
|
+
| **schedule** | **String** | Optional. | [optional] |
|
|
53
|
+
| **next_run** | **Time** | Optional. | [optional] |
|
|
54
|
+
| **data_time_period_start** | **Time** | Start date of the data time period covered | [optional] |
|
|
55
|
+
| **data_time_period_end** | **Time** | End date of the data time period covered | [optional] |
|
|
56
|
+
| **date_collection_start** | **Time** | When the seller began actively collecting this data. Distinct from data_time_period_start, which describes when the records themselves begin. Backfilled historical data will have date_collection_start > data_time_period_start. | [optional] |
|
|
57
|
+
| **geographic_coverage_type** | **String** | Type of geographic coverage | [optional] |
|
|
58
|
+
| **geographic_coverage_details** | **String** | Specific regions/countries covered (e.g., 'United States, Canada, Mexico') | [optional] |
|
|
59
|
+
| **data_source_refresh_frequency** | **String** | How often the source data is refreshed | [optional] |
|
|
60
|
+
| **rate_limit_number** | **Integer** | Number of requests allowed per period (e.g., 100) | [optional] |
|
|
61
|
+
| **rate_limit_period** | **String** | Time period for rate limiting (second, minute, hour, day) | [optional] |
|
|
62
|
+
| **rate_limit_granularity** | **String** | Granularity level for rate limiting (USER, COMPANY, IP) | [optional] |
|
|
63
|
+
|
|
64
|
+
## Example
|
|
65
|
+
|
|
66
|
+
```ruby
|
|
67
|
+
require 'spartera_api_sdk'
|
|
68
|
+
|
|
69
|
+
instance = SparteraApiSdk::AssetsInput.new(
|
|
70
|
+
user_id: user_id_abc123,
|
|
71
|
+
company_id: company_id_abc123,
|
|
72
|
+
connection_id: connection_id_abc123,
|
|
73
|
+
industry_id: 1,
|
|
74
|
+
auc_id: 1,
|
|
75
|
+
function_id: function_id_abc123,
|
|
76
|
+
approval_status: PENDING,
|
|
77
|
+
approved_by_user_id: approved_by_user_id_abc123,
|
|
78
|
+
approved_at: 2025-04-01T00:00:00Z,
|
|
79
|
+
name: Example Name,
|
|
80
|
+
slug: example-slug,
|
|
81
|
+
description: Example description.,
|
|
82
|
+
detailed_description: Example description.,
|
|
83
|
+
source: MANUAL,
|
|
84
|
+
asset_type: CALCULATION,
|
|
85
|
+
asset_schema: {},
|
|
86
|
+
tags: example_value,
|
|
87
|
+
top_questions: example_value,
|
|
88
|
+
short_code: ABC123,
|
|
89
|
+
restricted_domains: example.com,
|
|
90
|
+
sql_logic: example_value,
|
|
91
|
+
source_schema_name: Example Name,
|
|
92
|
+
source_table_name: Example Name,
|
|
93
|
+
sell_in_marketplace: true,
|
|
94
|
+
require_customization: true,
|
|
95
|
+
viz_spec: {},
|
|
96
|
+
viz_chart_library: PLOTLY,
|
|
97
|
+
viz_chart_type: LINE,
|
|
98
|
+
viz_dep_var_col_name: Example Name,
|
|
99
|
+
viz_indep_var_col_name: Example Name,
|
|
100
|
+
viz_size_col_name: Example Name,
|
|
101
|
+
viz_color_col_name: Example Name,
|
|
102
|
+
viz_data_aggregation: No Aggregation,
|
|
103
|
+
viz_sort_direction: No Sorting,
|
|
104
|
+
viz_data_limit: 1,
|
|
105
|
+
viz_color_scheme: Default,
|
|
106
|
+
viz_show_legend: true,
|
|
107
|
+
viz_show_grid: true,
|
|
108
|
+
viz_show_trendline: true,
|
|
109
|
+
viz_line_smoothing: true,
|
|
110
|
+
viz_bar_stacked: true,
|
|
111
|
+
viz_filter_direction: TOP,
|
|
112
|
+
allow_params: true,
|
|
113
|
+
accept_terms: true,
|
|
114
|
+
cached: true,
|
|
115
|
+
schedule: example_value,
|
|
116
|
+
next_run: 2025-04-01T00:00:00Z,
|
|
117
|
+
data_time_period_start: 2025-04-01T00:00:00Z,
|
|
118
|
+
data_time_period_end: 2025-04-01T00:00:00Z,
|
|
119
|
+
date_collection_start: 2025-04-01T00:00:00Z,
|
|
120
|
+
geographic_coverage_type: GLOBAL,
|
|
121
|
+
geographic_coverage_details: example_value,
|
|
122
|
+
data_source_refresh_frequency: EVERY_SECOND,
|
|
123
|
+
rate_limit_number: 0.15,
|
|
124
|
+
rate_limit_period: SECOND,
|
|
125
|
+
rate_limit_granularity: USER
|
|
126
|
+
)
|
|
127
|
+
```
|
|
128
|
+
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# SparteraApiSdk::AssetsUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
|
|
8
|
+
| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | [optional] |
|
|
9
|
+
| **connection_id** | **String** | Optional. | [optional] |
|
|
10
|
+
| **industry_id** | **Integer** | References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional. | [optional] |
|
|
11
|
+
| **auc_id** | **Integer** | Primary use case for this asset, from clustering analysis | [optional] |
|
|
12
|
+
| **function_id** | **String** | Optional identifier for routing to specific functions/models at seller endpoint. For GET: appended to URL path. For POST: included in JSON body. | [optional] |
|
|
13
|
+
| **approval_status** | **String** | Approval status for AI-generated assets | [optional] |
|
|
14
|
+
| **approved_by_user_id** | **String** | User who approved this asset for marketplace | [optional] |
|
|
15
|
+
| **approved_at** | **Time** | When this asset was approved for marketplace | [optional] |
|
|
16
|
+
| **name** | **String** | Required. | [optional] |
|
|
17
|
+
| **slug** | **String** | Optional. | [optional] |
|
|
18
|
+
| **description** | **String** | Optional. | [optional] |
|
|
19
|
+
| **detailed_description** | **String** | Long-form HTML description for product pages and SEO | [optional] |
|
|
20
|
+
| **source** | **String** | Required. One of: MANUAL, AUTOMATIC. | [optional] |
|
|
21
|
+
| **asset_type** | **String** | Optional. One of: CALCULATION, VISUALIZATION, DATA. | [optional] |
|
|
22
|
+
| **asset_schema** | **Object** | Stores database table schema data including columns, types, and metadata | [optional] |
|
|
23
|
+
| **tags** | **String** | Optional. | [optional] |
|
|
24
|
+
| **top_questions** | **String** | Top 3 questions this asset can help answer, in English. Stored as JSON array of strings (1-3 items, 15-200 chars each). Required for marketplace assets. | [optional] |
|
|
25
|
+
| **short_code** | **String** | Short code for tera.ac URL shortener (e.g., 'f78zq1') | [optional] |
|
|
26
|
+
| **restricted_domains** | **String** | Semicolon or comma-separated list of domains restricted from accessing this asset | [optional] |
|
|
27
|
+
| **sql_logic** | **String** | Optional. | [optional] |
|
|
28
|
+
| **source_schema_name** | **String** | Optional. | [optional] |
|
|
29
|
+
| **source_table_name** | **String** | Optional. | [optional] |
|
|
30
|
+
| **sell_in_marketplace** | **Boolean** | Required. | [optional] |
|
|
31
|
+
| **require_customization** | **Boolean** | Whether this asset requires customization before use | [optional] |
|
|
32
|
+
| **viz_spec** | **Object** | Plotly figure JSON describing the visualization. Authored via the visual editor or via API. When populated, takes precedence over the legacy viz_* fields. Shape follows Plotly's figure schema: {data: [{type: '...', xsrc: '...', ...}], layout: {...}}. Column references use *src keys (xsrc, ysrc, labelssrc, etc.) and are hydrated with actual data at render time. | [optional] |
|
|
33
|
+
| **viz_chart_library** | **String** | Optional. One of: PLOTLY, MATPLOTLIB, SEABORN. | [optional] |
|
|
34
|
+
| **viz_chart_type** | **String** | Optional. One of: LINE, BAR, PIE, DOUGHNUT, POLAR, … (8 total). | [optional] |
|
|
35
|
+
| **viz_dep_var_col_name** | **String** | Optional. | [optional] |
|
|
36
|
+
| **viz_indep_var_col_name** | **String** | Optional. | [optional] |
|
|
37
|
+
| **viz_size_col_name** | **String** | Optional. | [optional] |
|
|
38
|
+
| **viz_color_col_name** | **String** | Optional. | [optional] |
|
|
39
|
+
| **viz_data_aggregation** | **String** | Optional. One of: No Aggregation, Sum, Average, Count, Minimum, … (6 total). | [optional] |
|
|
40
|
+
| **viz_sort_direction** | **String** | Optional. One of: No Sorting, Ascending, Descending. | [optional] |
|
|
41
|
+
| **viz_data_limit** | **Integer** | Optional. | [optional] |
|
|
42
|
+
| **viz_color_scheme** | **String** | Optional. One of: Default, Sequential, Diverging, Categorical, Monochrome, … (8 total). | [optional] |
|
|
43
|
+
| **viz_show_legend** | **Boolean** | Show/hide chart legend | [optional] |
|
|
44
|
+
| **viz_show_grid** | **Boolean** | Show/hide grid lines | [optional] |
|
|
45
|
+
| **viz_show_trendline** | **Boolean** | Show trendline for scatter/line charts | [optional] |
|
|
46
|
+
| **viz_line_smoothing** | **Boolean** | Enable smoothing for line charts | [optional] |
|
|
47
|
+
| **viz_bar_stacked** | **Boolean** | Stack bars instead of grouping | [optional] |
|
|
48
|
+
| **viz_filter_direction** | **String** | Whether data_limit shows TOP or BOTTOM N | [optional] |
|
|
49
|
+
| **allow_params** | **Boolean** | Required. | [optional] |
|
|
50
|
+
| **accept_terms** | **Boolean** | Required. | [optional] |
|
|
51
|
+
| **cached** | **Boolean** | Optional. | [optional] |
|
|
52
|
+
| **schedule** | **String** | Optional. | [optional] |
|
|
53
|
+
| **next_run** | **Time** | Optional. | [optional] |
|
|
54
|
+
| **data_time_period_start** | **Time** | Start date of the data time period covered | [optional] |
|
|
55
|
+
| **data_time_period_end** | **Time** | End date of the data time period covered | [optional] |
|
|
56
|
+
| **date_collection_start** | **Time** | When the seller began actively collecting this data. Distinct from data_time_period_start, which describes when the records themselves begin. Backfilled historical data will have date_collection_start > data_time_period_start. | [optional] |
|
|
57
|
+
| **geographic_coverage_type** | **String** | Type of geographic coverage | [optional] |
|
|
58
|
+
| **geographic_coverage_details** | **String** | Specific regions/countries covered (e.g., 'United States, Canada, Mexico') | [optional] |
|
|
59
|
+
| **data_source_refresh_frequency** | **String** | How often the source data is refreshed | [optional] |
|
|
60
|
+
| **rate_limit_number** | **Integer** | Number of requests allowed per period (e.g., 100) | [optional] |
|
|
61
|
+
| **rate_limit_period** | **String** | Time period for rate limiting (second, minute, hour, day) | [optional] |
|
|
62
|
+
| **rate_limit_granularity** | **String** | Granularity level for rate limiting (USER, COMPANY, IP) | [optional] |
|
|
63
|
+
|
|
64
|
+
## Example
|
|
65
|
+
|
|
66
|
+
```ruby
|
|
67
|
+
require 'spartera_api_sdk'
|
|
68
|
+
|
|
69
|
+
instance = SparteraApiSdk::AssetsUpdate.new(
|
|
70
|
+
user_id: user_id_abc123,
|
|
71
|
+
company_id: company_id_abc123,
|
|
72
|
+
connection_id: connection_id_abc123,
|
|
73
|
+
industry_id: 1,
|
|
74
|
+
auc_id: 1,
|
|
75
|
+
function_id: function_id_abc123,
|
|
76
|
+
approval_status: PENDING,
|
|
77
|
+
approved_by_user_id: approved_by_user_id_abc123,
|
|
78
|
+
approved_at: 2025-04-01T00:00:00Z,
|
|
79
|
+
name: Example Name,
|
|
80
|
+
slug: example-slug,
|
|
81
|
+
description: Example description.,
|
|
82
|
+
detailed_description: Example description.,
|
|
83
|
+
source: MANUAL,
|
|
84
|
+
asset_type: CALCULATION,
|
|
85
|
+
asset_schema: {},
|
|
86
|
+
tags: example_value,
|
|
87
|
+
top_questions: example_value,
|
|
88
|
+
short_code: ABC123,
|
|
89
|
+
restricted_domains: example.com,
|
|
90
|
+
sql_logic: example_value,
|
|
91
|
+
source_schema_name: Example Name,
|
|
92
|
+
source_table_name: Example Name,
|
|
93
|
+
sell_in_marketplace: true,
|
|
94
|
+
require_customization: true,
|
|
95
|
+
viz_spec: {},
|
|
96
|
+
viz_chart_library: PLOTLY,
|
|
97
|
+
viz_chart_type: LINE,
|
|
98
|
+
viz_dep_var_col_name: Example Name,
|
|
99
|
+
viz_indep_var_col_name: Example Name,
|
|
100
|
+
viz_size_col_name: Example Name,
|
|
101
|
+
viz_color_col_name: Example Name,
|
|
102
|
+
viz_data_aggregation: No Aggregation,
|
|
103
|
+
viz_sort_direction: No Sorting,
|
|
104
|
+
viz_data_limit: 1,
|
|
105
|
+
viz_color_scheme: Default,
|
|
106
|
+
viz_show_legend: true,
|
|
107
|
+
viz_show_grid: true,
|
|
108
|
+
viz_show_trendline: true,
|
|
109
|
+
viz_line_smoothing: true,
|
|
110
|
+
viz_bar_stacked: true,
|
|
111
|
+
viz_filter_direction: TOP,
|
|
112
|
+
allow_params: true,
|
|
113
|
+
accept_terms: true,
|
|
114
|
+
cached: true,
|
|
115
|
+
schedule: example_value,
|
|
116
|
+
next_run: 2025-04-01T00:00:00Z,
|
|
117
|
+
data_time_period_start: 2025-04-01T00:00:00Z,
|
|
118
|
+
data_time_period_end: 2025-04-01T00:00:00Z,
|
|
119
|
+
date_collection_start: 2025-04-01T00:00:00Z,
|
|
120
|
+
geographic_coverage_type: GLOBAL,
|
|
121
|
+
geographic_coverage_details: example_value,
|
|
122
|
+
data_source_refresh_frequency: EVERY_SECOND,
|
|
123
|
+
rate_limit_number: 0.15,
|
|
124
|
+
rate_limit_period: SECOND,
|
|
125
|
+
rate_limit_granularity: USER
|
|
126
|
+
)
|
|
127
|
+
```
|
|
128
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# SparteraApiSdk::CloudProviders
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date_created** | **Time** | Optional. | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | Optional. | [optional] |
|
|
9
|
+
| **provider_id** | **Integer** | Auto-generated unique identifier. | [optional] |
|
|
10
|
+
| **name** | **String** | Required. | |
|
|
11
|
+
| **parent_company** | **String** | Optional. | [optional] |
|
|
12
|
+
| **marketing_homepage_url** | **String** | Optional. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'spartera_api_sdk'
|
|
18
|
+
|
|
19
|
+
instance = SparteraApiSdk::CloudProviders.new(
|
|
20
|
+
date_created: 2025-04-01T00:00:00Z,
|
|
21
|
+
last_updated: 2025-04-01T00:00:00Z,
|
|
22
|
+
provider_id: 1,
|
|
23
|
+
name: Example Name,
|
|
24
|
+
parent_company: example_value,
|
|
25
|
+
marketing_homepage_url: https://example.com
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# SparteraApiSdk::CloudProvidersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spartera.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_cloud_providers_by_id**](CloudProvidersApi.md#get_cloud_providers_by_id) | **GET** /cloud-providers/{provider_id} | Get single cloud provider by ID |
|
|
8
|
+
| [**list_cloud_providers**](CloudProvidersApi.md#list_cloud_providers) | **GET** /cloud-providers | Get a list of all cloud providers |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## get_cloud_providers_by_id
|
|
12
|
+
|
|
13
|
+
> <GetCloudProvidersById200Response> get_cloud_providers_by_id(provider_id)
|
|
14
|
+
|
|
15
|
+
Get single cloud provider by ID
|
|
16
|
+
|
|
17
|
+
### Examples
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'time'
|
|
21
|
+
require 'spartera_api_sdk'
|
|
22
|
+
# setup authorization
|
|
23
|
+
SparteraApiSdk.configure do |config|
|
|
24
|
+
# Configure API key authorization: ApiKeyAuth
|
|
25
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
27
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = SparteraApiSdk::CloudProvidersApi.new
|
|
31
|
+
provider_id = 'provider_id_example' # String | Unique identifier for the Provider
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
# Get single cloud provider by ID
|
|
35
|
+
result = api_instance.get_cloud_providers_by_id(provider_id)
|
|
36
|
+
p result
|
|
37
|
+
rescue SparteraApiSdk::ApiError => e
|
|
38
|
+
puts "Error when calling CloudProvidersApi->get_cloud_providers_by_id: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
#### Using the get_cloud_providers_by_id_with_http_info variant
|
|
43
|
+
|
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
|
45
|
+
|
|
46
|
+
> <Array(<GetCloudProvidersById200Response>, Integer, Hash)> get_cloud_providers_by_id_with_http_info(provider_id)
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
begin
|
|
50
|
+
# Get single cloud provider by ID
|
|
51
|
+
data, status_code, headers = api_instance.get_cloud_providers_by_id_with_http_info(provider_id)
|
|
52
|
+
p status_code # => 2xx
|
|
53
|
+
p headers # => { ... }
|
|
54
|
+
p data # => <GetCloudProvidersById200Response>
|
|
55
|
+
rescue SparteraApiSdk::ApiError => e
|
|
56
|
+
puts "Error when calling CloudProvidersApi->get_cloud_providers_by_id_with_http_info: #{e}"
|
|
57
|
+
end
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Name | Type | Description | Notes |
|
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
|
64
|
+
| **provider_id** | **String** | Unique identifier for the Provider | |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**GetCloudProvidersById200Response**](GetCloudProvidersById200Response.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: Not defined
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## list_cloud_providers
|
|
81
|
+
|
|
82
|
+
> <ListCloudProviders200Response> list_cloud_providers(opts)
|
|
83
|
+
|
|
84
|
+
Get a list of all cloud providers
|
|
85
|
+
|
|
86
|
+
### Examples
|
|
87
|
+
|
|
88
|
+
```ruby
|
|
89
|
+
require 'time'
|
|
90
|
+
require 'spartera_api_sdk'
|
|
91
|
+
# setup authorization
|
|
92
|
+
SparteraApiSdk.configure do |config|
|
|
93
|
+
# Configure API key authorization: ApiKeyAuth
|
|
94
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
95
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
96
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
api_instance = SparteraApiSdk::CloudProvidersApi.new
|
|
100
|
+
opts = {
|
|
101
|
+
page: 56, # Integer | Page number for pagination
|
|
102
|
+
limit: 56, # Integer | Number of items per page
|
|
103
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
104
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
105
|
+
search: 'search_example' # String | Search term to filter results
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
begin
|
|
109
|
+
# Get a list of all cloud providers
|
|
110
|
+
result = api_instance.list_cloud_providers(opts)
|
|
111
|
+
p result
|
|
112
|
+
rescue SparteraApiSdk::ApiError => e
|
|
113
|
+
puts "Error when calling CloudProvidersApi->list_cloud_providers: #{e}"
|
|
114
|
+
end
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### Using the list_cloud_providers_with_http_info variant
|
|
118
|
+
|
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
120
|
+
|
|
121
|
+
> <Array(<ListCloudProviders200Response>, Integer, Hash)> list_cloud_providers_with_http_info(opts)
|
|
122
|
+
|
|
123
|
+
```ruby
|
|
124
|
+
begin
|
|
125
|
+
# Get a list of all cloud providers
|
|
126
|
+
data, status_code, headers = api_instance.list_cloud_providers_with_http_info(opts)
|
|
127
|
+
p status_code # => 2xx
|
|
128
|
+
p headers # => { ... }
|
|
129
|
+
p data # => <ListCloudProviders200Response>
|
|
130
|
+
rescue SparteraApiSdk::ApiError => e
|
|
131
|
+
puts "Error when calling CloudProvidersApi->list_cloud_providers_with_http_info: #{e}"
|
|
132
|
+
end
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
|
139
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
140
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
141
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
142
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
143
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**ListCloudProviders200Response**](ListCloudProviders200Response.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: Not defined
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SparteraApiSdk::CloudProvidersInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Required. | |
|
|
8
|
+
| **parent_company** | **String** | Optional. | [optional] |
|
|
9
|
+
| **marketing_homepage_url** | **String** | Optional. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'spartera_api_sdk'
|
|
15
|
+
|
|
16
|
+
instance = SparteraApiSdk::CloudProvidersInput.new(
|
|
17
|
+
name: Example Name,
|
|
18
|
+
parent_company: example_value,
|
|
19
|
+
marketing_homepage_url: https://example.com
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SparteraApiSdk::CloudProvidersUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Required. | [optional] |
|
|
8
|
+
| **parent_company** | **String** | Optional. | [optional] |
|
|
9
|
+
| **marketing_homepage_url** | **String** | Optional. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'spartera_api_sdk'
|
|
15
|
+
|
|
16
|
+
instance = SparteraApiSdk::CloudProvidersUpdate.new(
|
|
17
|
+
name: Example Name,
|
|
18
|
+
parent_company: example_value,
|
|
19
|
+
marketing_homepage_url: https://example.com
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Companies.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# SparteraApiSdk::Companies
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date_created** | **Time** | Optional. | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | Optional. | [optional] |
|
|
9
|
+
| **company_id** | **String** | Unique identifier. | [optional] |
|
|
10
|
+
| **industry_id** | **Integer** | References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional. | [optional] |
|
|
11
|
+
| **country_id** | **Integer** | References countries.country_id — List of countries of the world. See GET /countries for valid values. Optional. | [optional] |
|
|
12
|
+
| **company_name** | **String** | Optional. | [optional] |
|
|
13
|
+
| **company_description** | **String** | Optional. | [optional] |
|
|
14
|
+
| **company_handle** | **String** | Required. Must be unique. | |
|
|
15
|
+
| **company_domain** | **String** | Required. Must be unique. | |
|
|
16
|
+
| **credits_balance** | **Integer** | Current balance of credits for this company (buyer) | |
|
|
17
|
+
| **accepted_eula** | **Boolean** | Optional. | [optional] |
|
|
18
|
+
| **stripe_account_id** | **String** | Stripe Connect account ID for marketplace sellers | [optional] |
|
|
19
|
+
| **stripe_account_status** | **String** | Status of the Stripe account (verified, pending, etc.) | [optional] |
|
|
20
|
+
| **vendor_share_percent** | **Float** | Negotiated vendor revenue share (e.g. 0.85 = 85%). NULL = system default 80%. | [optional] |
|
|
21
|
+
| **partnership_type** | **String** | Partnership type: SELF_MANAGED, CUSTODIAN, or null | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'spartera_api_sdk'
|
|
27
|
+
|
|
28
|
+
instance = SparteraApiSdk::Companies.new(
|
|
29
|
+
date_created: 2025-04-01T00:00:00Z,
|
|
30
|
+
last_updated: 2025-04-01T00:00:00Z,
|
|
31
|
+
company_id: company_id_abc123,
|
|
32
|
+
industry_id: 1,
|
|
33
|
+
country_id: US,
|
|
34
|
+
company_name: Example Name,
|
|
35
|
+
company_description: Example description.,
|
|
36
|
+
company_handle: example_value,
|
|
37
|
+
company_domain: example.com,
|
|
38
|
+
credits_balance: 1,
|
|
39
|
+
accepted_eula: true,
|
|
40
|
+
stripe_account_id: stripe_account_id_abc123,
|
|
41
|
+
stripe_account_status: ACTIVE,
|
|
42
|
+
vendor_share_percent: 1.0,
|
|
43
|
+
partnership_type: SELF_MANAGED
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|