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
|
@@ -0,0 +1,597 @@
|
|
|
1
|
+
# SparteraApiSdk::FavoritesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spartera.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_favorites**](FavoritesApi.md#create_favorites) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites |
|
|
8
|
+
| [**delete_favorites**](FavoritesApi.md#delete_favorites) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset) |
|
|
9
|
+
| [**get_favorites_by_id**](FavoritesApi.md#get_favorites_by_id) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user |
|
|
10
|
+
| [**get_favorites_by_id_users**](FavoritesApi.md#get_favorites_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID |
|
|
11
|
+
| [**get_favorites_by_id_users_category**](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 |
|
|
12
|
+
| [**get_favorites_by_id_users_check**](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 |
|
|
13
|
+
| [**get_favorites_by_id_users_uncategorized**](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 |
|
|
14
|
+
| [**update_favorites**](FavoritesApi.md#update_favorites) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## create_favorites
|
|
18
|
+
|
|
19
|
+
> <CreateFavorites200Response> create_favorites(company_id, user_id, favorites_input)
|
|
20
|
+
|
|
21
|
+
POST /companies/{company_id}/users/{user_id}/favorites
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'time'
|
|
27
|
+
require 'spartera_api_sdk'
|
|
28
|
+
# setup authorization
|
|
29
|
+
SparteraApiSdk.configure do |config|
|
|
30
|
+
# Configure API key authorization: ApiKeyAuth
|
|
31
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
37
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
38
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
39
|
+
favorites_input = SparteraApiSdk::FavoritesInput.new({asset_id: 'asset_id_abc123', company_id: 'company_id_abc123'}) # FavoritesInput |
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
|
43
|
+
result = api_instance.create_favorites(company_id, user_id, favorites_input)
|
|
44
|
+
p result
|
|
45
|
+
rescue SparteraApiSdk::ApiError => e
|
|
46
|
+
puts "Error when calling FavoritesApi->create_favorites: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
#### Using the create_favorites_with_http_info variant
|
|
51
|
+
|
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
|
53
|
+
|
|
54
|
+
> <Array(<CreateFavorites200Response>, Integer, Hash)> create_favorites_with_http_info(company_id, user_id, favorites_input)
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
begin
|
|
58
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
|
59
|
+
data, status_code, headers = api_instance.create_favorites_with_http_info(company_id, user_id, favorites_input)
|
|
60
|
+
p status_code # => 2xx
|
|
61
|
+
p headers # => { ... }
|
|
62
|
+
p data # => <CreateFavorites200Response>
|
|
63
|
+
rescue SparteraApiSdk::ApiError => e
|
|
64
|
+
puts "Error when calling FavoritesApi->create_favorites_with_http_info: #{e}"
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
|
72
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
73
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
74
|
+
| **favorites_input** | [**FavoritesInput**](FavoritesInput.md) | | |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**CreateFavorites200Response**](CreateFavorites200Response.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## delete_favorites
|
|
91
|
+
|
|
92
|
+
> <DeleteFavorites200Response> delete_favorites(company_id, user_id, favorite_id)
|
|
93
|
+
|
|
94
|
+
Delete single favorite by ID (unfavorite an asset)
|
|
95
|
+
|
|
96
|
+
### Examples
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
require 'time'
|
|
100
|
+
require 'spartera_api_sdk'
|
|
101
|
+
# setup authorization
|
|
102
|
+
SparteraApiSdk.configure do |config|
|
|
103
|
+
# Configure API key authorization: ApiKeyAuth
|
|
104
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
106
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
110
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
111
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
112
|
+
favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
|
|
113
|
+
|
|
114
|
+
begin
|
|
115
|
+
# Delete single favorite by ID (unfavorite an asset)
|
|
116
|
+
result = api_instance.delete_favorites(company_id, user_id, favorite_id)
|
|
117
|
+
p result
|
|
118
|
+
rescue SparteraApiSdk::ApiError => e
|
|
119
|
+
puts "Error when calling FavoritesApi->delete_favorites: #{e}"
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
#### Using the delete_favorites_with_http_info variant
|
|
124
|
+
|
|
125
|
+
This returns an Array which contains the response data, status code and headers.
|
|
126
|
+
|
|
127
|
+
> <Array(<DeleteFavorites200Response>, Integer, Hash)> delete_favorites_with_http_info(company_id, user_id, favorite_id)
|
|
128
|
+
|
|
129
|
+
```ruby
|
|
130
|
+
begin
|
|
131
|
+
# Delete single favorite by ID (unfavorite an asset)
|
|
132
|
+
data, status_code, headers = api_instance.delete_favorites_with_http_info(company_id, user_id, favorite_id)
|
|
133
|
+
p status_code # => 2xx
|
|
134
|
+
p headers # => { ... }
|
|
135
|
+
p data # => <DeleteFavorites200Response>
|
|
136
|
+
rescue SparteraApiSdk::ApiError => e
|
|
137
|
+
puts "Error when calling FavoritesApi->delete_favorites_with_http_info: #{e}"
|
|
138
|
+
end
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
| Name | Type | Description | Notes |
|
|
144
|
+
| ---- | ---- | ----------- | ----- |
|
|
145
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
146
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
147
|
+
| **favorite_id** | **String** | Unique identifier for the Favorite | |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**DeleteFavorites200Response**](DeleteFavorites200Response.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: Not defined
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## get_favorites_by_id
|
|
164
|
+
|
|
165
|
+
> <GetFavoritesById200Response> get_favorites_by_id(company_id, user_id)
|
|
166
|
+
|
|
167
|
+
Get a list of all favorites for a specific user
|
|
168
|
+
|
|
169
|
+
### Examples
|
|
170
|
+
|
|
171
|
+
```ruby
|
|
172
|
+
require 'time'
|
|
173
|
+
require 'spartera_api_sdk'
|
|
174
|
+
# setup authorization
|
|
175
|
+
SparteraApiSdk.configure do |config|
|
|
176
|
+
# Configure API key authorization: ApiKeyAuth
|
|
177
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
179
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
183
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
184
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
185
|
+
|
|
186
|
+
begin
|
|
187
|
+
# Get a list of all favorites for a specific user
|
|
188
|
+
result = api_instance.get_favorites_by_id(company_id, user_id)
|
|
189
|
+
p result
|
|
190
|
+
rescue SparteraApiSdk::ApiError => e
|
|
191
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id: #{e}"
|
|
192
|
+
end
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
#### Using the get_favorites_by_id_with_http_info variant
|
|
196
|
+
|
|
197
|
+
This returns an Array which contains the response data, status code and headers.
|
|
198
|
+
|
|
199
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_with_http_info(company_id, user_id)
|
|
200
|
+
|
|
201
|
+
```ruby
|
|
202
|
+
begin
|
|
203
|
+
# Get a list of all favorites for a specific user
|
|
204
|
+
data, status_code, headers = api_instance.get_favorites_by_id_with_http_info(company_id, user_id)
|
|
205
|
+
p status_code # => 2xx
|
|
206
|
+
p headers # => { ... }
|
|
207
|
+
p data # => <GetFavoritesById200Response>
|
|
208
|
+
rescue SparteraApiSdk::ApiError => e
|
|
209
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_with_http_info: #{e}"
|
|
210
|
+
end
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
|
217
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
218
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## get_favorites_by_id_users
|
|
235
|
+
|
|
236
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users(company_id, user_id, favorite_id)
|
|
237
|
+
|
|
238
|
+
Get single favorite by ID
|
|
239
|
+
|
|
240
|
+
### Examples
|
|
241
|
+
|
|
242
|
+
```ruby
|
|
243
|
+
require 'time'
|
|
244
|
+
require 'spartera_api_sdk'
|
|
245
|
+
# setup authorization
|
|
246
|
+
SparteraApiSdk.configure do |config|
|
|
247
|
+
# Configure API key authorization: ApiKeyAuth
|
|
248
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
250
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
254
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
255
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
256
|
+
favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
|
|
257
|
+
|
|
258
|
+
begin
|
|
259
|
+
# Get single favorite by ID
|
|
260
|
+
result = api_instance.get_favorites_by_id_users(company_id, user_id, favorite_id)
|
|
261
|
+
p result
|
|
262
|
+
rescue SparteraApiSdk::ApiError => e
|
|
263
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users: #{e}"
|
|
264
|
+
end
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
#### Using the get_favorites_by_id_users_with_http_info variant
|
|
268
|
+
|
|
269
|
+
This returns an Array which contains the response data, status code and headers.
|
|
270
|
+
|
|
271
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
|
|
272
|
+
|
|
273
|
+
```ruby
|
|
274
|
+
begin
|
|
275
|
+
# Get single favorite by ID
|
|
276
|
+
data, status_code, headers = api_instance.get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
|
|
277
|
+
p status_code # => 2xx
|
|
278
|
+
p headers # => { ... }
|
|
279
|
+
p data # => <GetFavoritesById200Response>
|
|
280
|
+
rescue SparteraApiSdk::ApiError => e
|
|
281
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_with_http_info: #{e}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Parameters
|
|
286
|
+
|
|
287
|
+
| Name | Type | Description | Notes |
|
|
288
|
+
| ---- | ---- | ----------- | ----- |
|
|
289
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
290
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
291
|
+
| **favorite_id** | **String** | Unique identifier for the Favorite | |
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: Not defined
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
## get_favorites_by_id_users_category
|
|
308
|
+
|
|
309
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_category(company_id, user_id, category)
|
|
310
|
+
|
|
311
|
+
Get all favorites for the specified user in a specific category
|
|
312
|
+
|
|
313
|
+
### Examples
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
require 'time'
|
|
317
|
+
require 'spartera_api_sdk'
|
|
318
|
+
# setup authorization
|
|
319
|
+
SparteraApiSdk.configure do |config|
|
|
320
|
+
# Configure API key authorization: ApiKeyAuth
|
|
321
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
322
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
323
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
324
|
+
end
|
|
325
|
+
|
|
326
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
327
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
328
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
329
|
+
category = 'category_example' # String | Parameter for category
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Get all favorites for the specified user in a specific category
|
|
333
|
+
result = api_instance.get_favorites_by_id_users_category(company_id, user_id, category)
|
|
334
|
+
p result
|
|
335
|
+
rescue SparteraApiSdk::ApiError => e
|
|
336
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_category: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
#### Using the get_favorites_by_id_users_category_with_http_info variant
|
|
341
|
+
|
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
343
|
+
|
|
344
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_category_with_http_info(company_id, user_id, category)
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
begin
|
|
348
|
+
# Get all favorites for the specified user in a specific category
|
|
349
|
+
data, status_code, headers = api_instance.get_favorites_by_id_users_category_with_http_info(company_id, user_id, category)
|
|
350
|
+
p status_code # => 2xx
|
|
351
|
+
p headers # => { ... }
|
|
352
|
+
p data # => <GetFavoritesById200Response>
|
|
353
|
+
rescue SparteraApiSdk::ApiError => e
|
|
354
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_category_with_http_info: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
| Name | Type | Description | Notes |
|
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
|
362
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
363
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
364
|
+
| **category** | **String** | Parameter for category | |
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: Not defined
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
## get_favorites_by_id_users_check
|
|
381
|
+
|
|
382
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_check(company_id, user_id, asset_id)
|
|
383
|
+
|
|
384
|
+
Check if the specified user has favorited a specific asset
|
|
385
|
+
|
|
386
|
+
### Examples
|
|
387
|
+
|
|
388
|
+
```ruby
|
|
389
|
+
require 'time'
|
|
390
|
+
require 'spartera_api_sdk'
|
|
391
|
+
# setup authorization
|
|
392
|
+
SparteraApiSdk.configure do |config|
|
|
393
|
+
# Configure API key authorization: ApiKeyAuth
|
|
394
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
395
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
396
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
400
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
401
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
402
|
+
asset_id = 'asset_id_example' # String | Unique identifier for the Asset
|
|
403
|
+
|
|
404
|
+
begin
|
|
405
|
+
# Check if the specified user has favorited a specific asset
|
|
406
|
+
result = api_instance.get_favorites_by_id_users_check(company_id, user_id, asset_id)
|
|
407
|
+
p result
|
|
408
|
+
rescue SparteraApiSdk::ApiError => e
|
|
409
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_check: #{e}"
|
|
410
|
+
end
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
#### Using the get_favorites_by_id_users_check_with_http_info variant
|
|
414
|
+
|
|
415
|
+
This returns an Array which contains the response data, status code and headers.
|
|
416
|
+
|
|
417
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_check_with_http_info(company_id, user_id, asset_id)
|
|
418
|
+
|
|
419
|
+
```ruby
|
|
420
|
+
begin
|
|
421
|
+
# Check if the specified user has favorited a specific asset
|
|
422
|
+
data, status_code, headers = api_instance.get_favorites_by_id_users_check_with_http_info(company_id, user_id, asset_id)
|
|
423
|
+
p status_code # => 2xx
|
|
424
|
+
p headers # => { ... }
|
|
425
|
+
p data # => <GetFavoritesById200Response>
|
|
426
|
+
rescue SparteraApiSdk::ApiError => e
|
|
427
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_check_with_http_info: #{e}"
|
|
428
|
+
end
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### Parameters
|
|
432
|
+
|
|
433
|
+
| Name | Type | Description | Notes |
|
|
434
|
+
| ---- | ---- | ----------- | ----- |
|
|
435
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
436
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
437
|
+
| **asset_id** | **String** | Unique identifier for the Asset | |
|
|
438
|
+
|
|
439
|
+
### Return type
|
|
440
|
+
|
|
441
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
442
|
+
|
|
443
|
+
### Authorization
|
|
444
|
+
|
|
445
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
446
|
+
|
|
447
|
+
### HTTP request headers
|
|
448
|
+
|
|
449
|
+
- **Content-Type**: Not defined
|
|
450
|
+
- **Accept**: application/json
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
## get_favorites_by_id_users_uncategorized
|
|
454
|
+
|
|
455
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_uncategorized(company_id, user_id)
|
|
456
|
+
|
|
457
|
+
Get all favorites for the specified user that don't have a category
|
|
458
|
+
|
|
459
|
+
### Examples
|
|
460
|
+
|
|
461
|
+
```ruby
|
|
462
|
+
require 'time'
|
|
463
|
+
require 'spartera_api_sdk'
|
|
464
|
+
# setup authorization
|
|
465
|
+
SparteraApiSdk.configure do |config|
|
|
466
|
+
# Configure API key authorization: ApiKeyAuth
|
|
467
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
468
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
469
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
470
|
+
end
|
|
471
|
+
|
|
472
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
473
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
474
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
475
|
+
|
|
476
|
+
begin
|
|
477
|
+
# Get all favorites for the specified user that don't have a category
|
|
478
|
+
result = api_instance.get_favorites_by_id_users_uncategorized(company_id, user_id)
|
|
479
|
+
p result
|
|
480
|
+
rescue SparteraApiSdk::ApiError => e
|
|
481
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized: #{e}"
|
|
482
|
+
end
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
#### Using the get_favorites_by_id_users_uncategorized_with_http_info variant
|
|
486
|
+
|
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
|
488
|
+
|
|
489
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_uncategorized_with_http_info(company_id, user_id)
|
|
490
|
+
|
|
491
|
+
```ruby
|
|
492
|
+
begin
|
|
493
|
+
# Get all favorites for the specified user that don't have a category
|
|
494
|
+
data, status_code, headers = api_instance.get_favorites_by_id_users_uncategorized_with_http_info(company_id, user_id)
|
|
495
|
+
p status_code # => 2xx
|
|
496
|
+
p headers # => { ... }
|
|
497
|
+
p data # => <GetFavoritesById200Response>
|
|
498
|
+
rescue SparteraApiSdk::ApiError => e
|
|
499
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized_with_http_info: #{e}"
|
|
500
|
+
end
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
| Name | Type | Description | Notes |
|
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
|
507
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
508
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
509
|
+
|
|
510
|
+
### Return type
|
|
511
|
+
|
|
512
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
513
|
+
|
|
514
|
+
### Authorization
|
|
515
|
+
|
|
516
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
517
|
+
|
|
518
|
+
### HTTP request headers
|
|
519
|
+
|
|
520
|
+
- **Content-Type**: Not defined
|
|
521
|
+
- **Accept**: application/json
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
## update_favorites
|
|
525
|
+
|
|
526
|
+
> <UpdateFavorites200Response> update_favorites(company_id, user_id, favorite_id, favorites_update)
|
|
527
|
+
|
|
528
|
+
Update an existing favorite by ID
|
|
529
|
+
|
|
530
|
+
### Examples
|
|
531
|
+
|
|
532
|
+
```ruby
|
|
533
|
+
require 'time'
|
|
534
|
+
require 'spartera_api_sdk'
|
|
535
|
+
# setup authorization
|
|
536
|
+
SparteraApiSdk.configure do |config|
|
|
537
|
+
# Configure API key authorization: ApiKeyAuth
|
|
538
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
539
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
540
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
541
|
+
end
|
|
542
|
+
|
|
543
|
+
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
544
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
545
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
546
|
+
favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
|
|
547
|
+
favorites_update = SparteraApiSdk::FavoritesUpdate.new # FavoritesUpdate |
|
|
548
|
+
|
|
549
|
+
begin
|
|
550
|
+
# Update an existing favorite by ID
|
|
551
|
+
result = api_instance.update_favorites(company_id, user_id, favorite_id, favorites_update)
|
|
552
|
+
p result
|
|
553
|
+
rescue SparteraApiSdk::ApiError => e
|
|
554
|
+
puts "Error when calling FavoritesApi->update_favorites: #{e}"
|
|
555
|
+
end
|
|
556
|
+
```
|
|
557
|
+
|
|
558
|
+
#### Using the update_favorites_with_http_info variant
|
|
559
|
+
|
|
560
|
+
This returns an Array which contains the response data, status code and headers.
|
|
561
|
+
|
|
562
|
+
> <Array(<UpdateFavorites200Response>, Integer, Hash)> update_favorites_with_http_info(company_id, user_id, favorite_id, favorites_update)
|
|
563
|
+
|
|
564
|
+
```ruby
|
|
565
|
+
begin
|
|
566
|
+
# Update an existing favorite by ID
|
|
567
|
+
data, status_code, headers = api_instance.update_favorites_with_http_info(company_id, user_id, favorite_id, favorites_update)
|
|
568
|
+
p status_code # => 2xx
|
|
569
|
+
p headers # => { ... }
|
|
570
|
+
p data # => <UpdateFavorites200Response>
|
|
571
|
+
rescue SparteraApiSdk::ApiError => e
|
|
572
|
+
puts "Error when calling FavoritesApi->update_favorites_with_http_info: #{e}"
|
|
573
|
+
end
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
### Parameters
|
|
577
|
+
|
|
578
|
+
| Name | Type | Description | Notes |
|
|
579
|
+
| ---- | ---- | ----------- | ----- |
|
|
580
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
581
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
582
|
+
| **favorite_id** | **String** | Unique identifier for the Favorite | |
|
|
583
|
+
| **favorites_update** | [**FavoritesUpdate**](FavoritesUpdate.md) | | |
|
|
584
|
+
|
|
585
|
+
### Return type
|
|
586
|
+
|
|
587
|
+
[**UpdateFavorites200Response**](UpdateFavorites200Response.md)
|
|
588
|
+
|
|
589
|
+
### Authorization
|
|
590
|
+
|
|
591
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
592
|
+
|
|
593
|
+
### HTTP request headers
|
|
594
|
+
|
|
595
|
+
- **Content-Type**: application/json
|
|
596
|
+
- **Accept**: application/json
|
|
597
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# SparteraApiSdk::FavoritesInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. | |
|
|
8
|
+
| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
|
|
9
|
+
| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | |
|
|
10
|
+
| **notes** | **String** | Optional user notes about this favorite | [optional] |
|
|
11
|
+
| **category** | **String** | Optional category for organizing favorites (e.g., 'Work', 'Research') | [optional] |
|
|
12
|
+
| **priority** | **Integer** | User-defined priority for sorting (higher = more important) | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'spartera_api_sdk'
|
|
18
|
+
|
|
19
|
+
instance = SparteraApiSdk::FavoritesInput.new(
|
|
20
|
+
asset_id: asset_id_abc123,
|
|
21
|
+
user_id: user_id_abc123,
|
|
22
|
+
company_id: company_id_abc123,
|
|
23
|
+
notes: example_value,
|
|
24
|
+
category: example_value,
|
|
25
|
+
priority: 1
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# SparteraApiSdk::FavoritesUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. | [optional] |
|
|
8
|
+
| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
|
|
9
|
+
| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | [optional] |
|
|
10
|
+
| **notes** | **String** | Optional user notes about this favorite | [optional] |
|
|
11
|
+
| **category** | **String** | Optional category for organizing favorites (e.g., 'Work', 'Research') | [optional] |
|
|
12
|
+
| **priority** | **Integer** | User-defined priority for sorting (higher = more important) | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'spartera_api_sdk'
|
|
18
|
+
|
|
19
|
+
instance = SparteraApiSdk::FavoritesUpdate.new(
|
|
20
|
+
asset_id: asset_id_abc123,
|
|
21
|
+
user_id: user_id_abc123,
|
|
22
|
+
company_id: company_id_abc123,
|
|
23
|
+
notes: example_value,
|
|
24
|
+
category: example_value,
|
|
25
|
+
priority: 1
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SparteraApiSdk::GetAlertsById200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | Response status message | |
|
|
8
|
+
| **data** | [**Alerts**](Alerts.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'spartera_api_sdk'
|
|
14
|
+
|
|
15
|
+
instance = SparteraApiSdk::GetAlertsById200Response.new(
|
|
16
|
+
message: success,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SparteraApiSdk::GetApiKeysById200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | Response status message | |
|
|
8
|
+
| **data** | [**ApiKeys**](ApiKeys.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'spartera_api_sdk'
|
|
14
|
+
|
|
15
|
+
instance = SparteraApiSdk::GetApiKeysById200Response.new(
|
|
16
|
+
message: success,
|
|
17
|
+
data: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|