spartera_api_sdk 1.0.74 → 1.0.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/Gemfile +9 -0
- data/README.md +333 -324
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +261 -87
- data/docs/Alerts.md +30 -0
- data/docs/AlertsApi.md +139 -139
- data/docs/AlertsInput.md +24 -0
- data/docs/AlertsUpdate.md +24 -0
- data/docs/ApiKeys.md +40 -0
- data/docs/ApiKeysInput.md +34 -0
- data/docs/ApiKeysUpdate.md +34 -0
- data/docs/AssetPriceHistory.md +30 -0
- data/docs/AssetPriceHistoryApi.md +162 -154
- data/docs/AssetPriceHistoryInput.md +24 -0
- data/docs/AssetPriceHistoryUpdate.md +24 -0
- data/docs/AssetUsecases.md +28 -0
- data/docs/AssetUsecasesApi.md +157 -0
- data/docs/Assets.md +138 -0
- data/docs/AssetsApi.md +534 -206
- data/docs/AssetsInput.md +124 -0
- data/docs/AssetsUpdate.md +124 -0
- data/docs/CloudProviders.md +28 -0
- data/docs/CloudProvidersApi.md +44 -31
- data/docs/CloudProvidersInput.md +22 -0
- data/docs/CloudProvidersUpdate.md +22 -0
- data/docs/Companies.md +46 -0
- data/docs/CompaniesApi.md +312 -144
- data/docs/CompaniesInput.md +40 -0
- data/docs/CompaniesUpdate.md +40 -0
- data/docs/Connections.md +38 -0
- data/docs/ConnectionsApi.md +149 -125
- data/docs/ConnectionsInput.md +32 -0
- data/docs/ConnectionsUpdate.md +32 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdGet200Response.md → CreateAlerts200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md → CreateAlerts200ResponseData.md} +2 -2
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/CreateApiKeys200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → CreateAssetPriceHistory200Response.md} +3 -3
- data/docs/CreateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/CreateAssetsAnalyze200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsPost200ResponseData.md → CreateAssetsAnalyze200ResponseData.md} +2 -2
- data/docs/CreateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsPost200ResponseData.md → CreateConnections200ResponseData.md} +2 -2
- data/docs/CreateEndpoints200Response.md +20 -0
- data/docs/CreateEndpoints200ResponseData.md +18 -0
- data/docs/CreateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md → CreateFavorites200ResponseData.md} +2 -2
- data/docs/CreatePostgenIntegrations200Response.md +20 -0
- data/docs/CreatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdAssetsGet200Response.md → CreatePosts200Response.md} +3 -3
- data/docs/CreatePosts200ResponseData.md +18 -0
- data/docs/CreateUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersPost200ResponseData.md → CreateUsers200ResponseData.md} +2 -2
- data/docs/DeleteAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md → DeleteAlerts200ResponseData.md} +2 -2
- data/docs/DeleteApiKeys200Response.md +20 -0
- data/docs/DeleteApiKeys200ResponseData.md +18 -0
- data/docs/DeleteAssetPriceHistory200Response.md +20 -0
- data/docs/DeleteAssetPriceHistory200ResponseData.md +18 -0
- data/docs/DeleteAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md → DeleteAssets200ResponseData.md} +2 -2
- data/docs/DeleteConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md → DeleteConnections200ResponseData.md} +2 -2
- data/docs/DeleteEndpoints200Response.md +20 -0
- data/docs/DeleteEndpoints200ResponseData.md +18 -0
- data/docs/DeleteFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md → DeleteFavorites200ResponseData.md} +2 -2
- data/docs/DeletePostgenIntegrations200Response.md +20 -0
- data/docs/DeletePostgenIntegrations200ResponseData.md +18 -0
- data/docs/DeletePosts200Response.md +20 -0
- data/docs/DeletePosts200ResponseData.md +18 -0
- data/docs/DeleteUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdDelete200ResponseData.md → DeleteUsers200ResponseData.md} +2 -2
- data/docs/Endpoints.md +80 -0
- data/docs/EndpointsApi.md +1043 -0
- data/docs/EndpointsInput.md +78 -0
- data/docs/EndpointsUpdate.md +78 -0
- data/docs/Favorites.md +34 -0
- data/docs/FavoritesApi.md +159 -159
- data/docs/FavoritesInput.md +28 -0
- data/docs/FavoritesUpdate.md +28 -0
- data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetAlertsById200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersGet200Response.md → GetApiKeysById200Response.md} +3 -3
- data/docs/GetAssetPriceHistoryById200Response.md +20 -0
- data/docs/GetAssetUsecasesById200Response.md +20 -0
- data/docs/GetAssetsByIdAnalyze200Response.md +20 -0
- data/docs/GetCloudProvidersById200Response.md +20 -0
- data/docs/GetCompaniesById200Response.md +20 -0
- data/docs/GetConnectionsById200Response.md +20 -0
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
- data/docs/GetFavoritesById200Response.md +20 -0
- data/docs/GetIndustriesById200Response.md +20 -0
- data/docs/GetJobFunctionsById200Response.md +20 -0
- data/docs/GetPostgenIntegrationsById200Response.md +20 -0
- data/docs/GetPostsById200Response.md +20 -0
- data/docs/GetStorageEnginesById200Response.md +20 -0
- data/docs/GetUsersById200Response.md +20 -0
- data/docs/Industries.md +32 -0
- data/docs/IndustriesApi.md +237 -0
- data/docs/InlineObject4.md +20 -0
- data/docs/InlineObject5.md +20 -0
- data/docs/InlineObject6.md +22 -0
- data/docs/InlineObject7.md +20 -0
- data/docs/JobFunctions.md +24 -0
- data/docs/JobFunctionsApi.md +157 -0
- data/docs/JobFunctionsInput.md +18 -0
- data/docs/JobFunctionsUpdate.md +18 -0
- data/docs/ListApiKeys200Response.md +20 -0
- data/docs/ListAssetUsecases200Response.md +20 -0
- data/docs/ListAssets200Response.md +20 -0
- data/docs/ListCloudProviders200Response.md +20 -0
- data/docs/{CompaniesCompanyIdApiKeysGet200Response.md → ListCompaniesAnalyticsAssets200Response.md} +3 -3
- data/docs/ListConnections200Response.md +20 -0
- data/docs/ListEndpoints200Response.md +20 -0
- data/docs/ListIndustries200Response.md +20 -0
- data/docs/ListJobFunctions200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsGet200Response.md → ListPostgenIntegrations200Response.md} +3 -3
- data/docs/ListPosts200Response.md +20 -0
- data/docs/ListStorageEngines200Response.md +20 -0
- data/docs/ListUsers200Response.md +20 -0
- data/docs/PostPublications.md +40 -0
- data/docs/PostPublicationsInput.md +34 -0
- data/docs/PostPublicationsUpdate.md +34 -0
- data/docs/PostgenIntegrations.md +36 -0
- data/docs/PostgenIntegrationsApi.md +463 -0
- data/docs/PostgenIntegrationsInput.md +30 -0
- data/docs/PostgenIntegrationsUpdate.md +30 -0
- data/docs/Posts.md +68 -0
- data/docs/PostsApi.md +843 -0
- data/docs/PostsInput.md +62 -0
- data/docs/PostsUpdate.md +62 -0
- data/docs/StorageEngines.md +32 -0
- data/docs/StorageEnginesApi.md +40 -28
- data/docs/UpdateAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md → UpdateAlerts200ResponseData.md} +2 -2
- data/docs/UpdateApiKeys200Response.md +20 -0
- data/docs/UpdateApiKeys200ResponseData.md +18 -0
- data/docs/UpdateAssetPriceHistory200Response.md +20 -0
- data/docs/UpdateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/UpdateAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md → UpdateAssets200ResponseData.md} +2 -2
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/UpdateCompanies200ResponseData.md +18 -0
- data/docs/UpdateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md → UpdateConnections200ResponseData.md} +2 -2
- data/docs/UpdateEndpoints200Response.md +20 -0
- data/docs/UpdateEndpoints200ResponseData.md +18 -0
- data/docs/UpdateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md → UpdateFavorites200ResponseData.md} +2 -2
- data/docs/UpdatePostgenIntegrations200Response.md +20 -0
- data/docs/UpdatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/UpdatePosts200Response.md +20 -0
- data/docs/UpdatePosts200ResponseData.md +18 -0
- data/docs/UpdateUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdPatch200ResponseData.md → UpdateUsers200ResponseData.md} +2 -2
- data/docs/Users.md +36 -0
- data/docs/UsersApi.md +306 -101
- data/docs/UsersInput.md +30 -0
- data/docs/UsersUpdate.md +30 -0
- data/git_push.sh +57 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +414 -167
- data/lib/spartera_api_sdk/api/api_keys_api.rb +491 -90
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +460 -169
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +952 -228
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +83 -31
- data/lib/spartera_api_sdk/api/companies_api.rb +651 -137
- data/lib/spartera_api_sdk/api/connections_api.rb +376 -142
- data/lib/spartera_api_sdk/api/endpoints_api.rb +1416 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +456 -196
- data/lib/spartera_api_sdk/api/industries_api.rb +284 -0
- data/lib/spartera_api_sdk/api/job_functions_api.rb +190 -0
- data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +634 -0
- data/lib/spartera_api_sdk/api/posts_api.rb +1190 -0
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +107 -29
- data/lib/spartera_api_sdk/api/users_api.rb +581 -112
- data/lib/spartera_api_sdk/api_client.rb +8 -4
- data/lib/spartera_api_sdk/api_error.rb +2 -2
- data/lib/spartera_api_sdk/api_model_base.rb +88 -0
- data/lib/spartera_api_sdk/configuration.rb +2 -2
- data/lib/spartera_api_sdk/models/{alert.rb → alerts.rb} +46 -139
- data/lib/spartera_api_sdk/models/alerts_input.rb +213 -0
- data/lib/spartera_api_sdk/models/alerts_update.rb +179 -0
- data/lib/spartera_api_sdk/models/{apikey.rb → api_keys.rb} +98 -124
- data/lib/spartera_api_sdk/models/api_keys_input.rb +263 -0
- data/lib/spartera_api_sdk/models/api_keys_update.rb +229 -0
- data/lib/spartera_api_sdk/models/asset_price_history.rb +209 -0
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
- data/lib/spartera_api_sdk/models/assets.rb +1048 -0
- data/lib/spartera_api_sdk/models/assets_input.rb +898 -0
- data/lib/spartera_api_sdk/models/assets_update.rb +857 -0
- data/lib/spartera_api_sdk/models/{cloudprovider.rb → cloud_providers.rb} +35 -111
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +186 -0
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +169 -0
- data/lib/spartera_api_sdk/models/{company.rb → companies.rb} +90 -105
- data/lib/spartera_api_sdk/models/companies_input.rb +327 -0
- data/lib/spartera_api_sdk/models/companies_update.rb +293 -0
- data/lib/spartera_api_sdk/models/{connection.rb → connections.rb} +69 -186
- data/lib/spartera_api_sdk/models/connections_input.rb +287 -0
- data/lib/spartera_api_sdk/models/connections_update.rb +253 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_get200_response.rb → create_alerts200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_post200_response_data.rb → create_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_get200_response.rb → create_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{me_get200_response_api_key_info.rb → create_api_keys200_response_data.rb} +27 -94
- data/lib/spartera_api_sdk/models/{companies_company_id_users_post200_response.rb → create_asset_price_history200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_post200_response_data.rb → create_assets_analyze200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_post200_response_data.rb → create_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_post200_response_data.rb → create_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_post200_response_data.rb → create_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb → delete_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_delete200_response_data.rb → delete_assets200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_delete200_response_data.rb → delete_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb → delete_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_delete200_response_data.rb → delete_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/endpoints.rb +684 -0
- data/lib/spartera_api_sdk/models/endpoints_input.rb +582 -0
- data/lib/spartera_api_sdk/models/endpoints_update.rb +531 -0
- data/lib/spartera_api_sdk/models/error.rb +3 -76
- data/lib/spartera_api_sdk/models/{favorite.rb → favorites.rb} +38 -111
- data/lib/spartera_api_sdk/models/favorites_input.rb +233 -0
- data/lib/spartera_api_sdk/models/favorites_update.rb +199 -0
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_delete200_response.rb → get_endpoints_by_id_connections_describe200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_get200_response.rb → get_postgen_integrations_by_id200_response.rb} +7 -82
- data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/industries.rb +253 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object1.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object2.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object3.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object4.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object5.rb +156 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_get200_response.rb → inline_object6.rb} +22 -104
- data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
- data/lib/spartera_api_sdk/models/job_functions.rb +213 -0
- data/lib/spartera_api_sdk/models/job_functions_input.rb +166 -0
- data/lib/spartera_api_sdk/models/job_functions_update.rb +149 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_get200_response.rb → list_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_get200_response.rb → list_asset_usecases200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_get200_response.rb → list_assets200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_post200_response.rb → list_companies_analytics_assets200_response.rb} +9 -80
- data/lib/spartera_api_sdk/models/list_connections200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_industries200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_posts200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_users200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/post_publications.rb +327 -0
- data/lib/spartera_api_sdk/models/post_publications_input.rb +280 -0
- data/lib/spartera_api_sdk/models/post_publications_update.rb +229 -0
- data/lib/spartera_api_sdk/models/postgen_integrations.rb +341 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +294 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +209 -0
- data/lib/spartera_api_sdk/models/posts.rb +586 -0
- data/lib/spartera_api_sdk/models/posts_input.rb +437 -0
- data/lib/spartera_api_sdk/models/posts_update.rb +369 -0
- data/lib/spartera_api_sdk/models/storage_engines.rb +294 -0
- data/lib/spartera_api_sdk/models/update_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb → update_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_patch200_response_data.rb → update_assets200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_companies200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_patch200_response_data.rb → update_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb → update_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_patch200_response_data.rb → update_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{user.rb → users.rb} +112 -108
- data/lib/spartera_api_sdk/models/{me_get200_response_profile.rb → users_input.rb} +54 -139
- data/lib/spartera_api_sdk/models/{me_get200_response_token_metadata.rb → users_update.rb} +101 -110
- data/lib/spartera_api_sdk/version.rb +13 -1
- data/lib/spartera_api_sdk.rb +149 -56
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +50 -50
- data/spec/api/api_keys_api_spec.rb +67 -30
- data/spec/api/asset_price_history_api_spec.rb +57 -53
- data/spec/api/asset_usecases_api_spec.rb +61 -0
- data/spec/api/assets_api_spec.rb +134 -69
- data/spec/api/cloud_providers_api_spec.rb +16 -11
- data/spec/api/companies_api_spec.rb +99 -47
- data/spec/api/connections_api_spec.rb +53 -43
- data/spec/api/endpoints_api_spec.rb +215 -0
- data/spec/api/favorites_api_spec.rb +56 -56
- data/spec/api/industries_api_spec.rb +76 -0
- data/spec/api/job_functions_api_spec.rb +61 -0
- data/spec/api/postgen_integrations_api_spec.rb +117 -0
- data/spec/api/posts_api_spec.rb +186 -0
- data/spec/api/storage_engines_api_spec.rb +16 -11
- data/spec/api/users_api_spec.rb +83 -34
- data/spec/models/{me_get200_response_token_metadata_spec.rb → alerts_input_spec.rb} +12 -12
- data/spec/models/alerts_spec.rb +72 -0
- data/spec/models/alerts_update_spec.rb +54 -0
- data/spec/models/{apikey_spec.rb → api_keys_input_spec.rb} +14 -20
- data/spec/models/{assetpricehistory_spec.rb → api_keys_spec.rb} +25 -19
- data/spec/models/{user_spec.rb → api_keys_update_spec.rb} +15 -15
- data/spec/models/asset_price_history_input_spec.rb +54 -0
- data/spec/models/asset_price_history_spec.rb +72 -0
- data/spec/models/asset_price_history_update_spec.rb +54 -0
- data/spec/models/asset_usecases_spec.rb +66 -0
- data/spec/models/{asset_spec.rb → assets_input_spec.rb} +122 -28
- data/spec/models/assets_spec.rb +452 -0
- data/spec/models/assets_update_spec.rb +406 -0
- data/spec/models/{companies_company_id_assets_asset_id_get200_response_spec.rb → cloud_providers_input_spec.rb} +16 -10
- data/spec/models/{cloudprovider_spec.rb → cloud_providers_spec.rb} +14 -20
- data/spec/models/{companies_company_id_assets_asset_id_delete200_response_spec.rb → cloud_providers_update_spec.rb} +16 -10
- data/spec/models/companies_input_spec.rb +106 -0
- data/spec/models/{company_spec.rb → companies_spec.rb} +26 -16
- data/spec/models/companies_update_spec.rb +106 -0
- data/spec/models/connections_input_spec.rb +82 -0
- data/spec/models/{me_get200_response_spec.rb → connections_spec.rb} +28 -22
- data/spec/models/connections_update_spec.rb +82 -0
- data/spec/models/create_alerts200_response_data_spec.rb +36 -0
- data/spec/models/create_alerts200_response_spec.rb +42 -0
- data/spec/models/create_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/create_api_keys200_response_spec.rb +42 -0
- data/spec/models/create_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/{companies_company_id_assets_post200_response_spec.rb → create_asset_price_history200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_assets_post200_response_data_spec.rb → create_assets_analyze200_response_data_spec.rb} +8 -8
- data/spec/models/{companies_company_id_users_post200_response_spec.rb → create_assets_analyze200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_connections_post200_response_data_spec.rb → create_connections200_response_data_spec.rb} +8 -8
- data/spec/models/create_connections200_response_spec.rb +42 -0
- data/spec/models/create_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/create_endpoints200_response_spec.rb +42 -0
- data/spec/models/create_favorites200_response_data_spec.rb +36 -0
- data/spec/models/create_favorites200_response_spec.rb +42 -0
- data/spec/models/create_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/create_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/create_posts200_response_data_spec.rb +36 -0
- data/spec/models/create_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_post200_response_data_spec.rb → create_users200_response_data_spec.rb} +8 -8
- data/spec/models/create_users200_response_spec.rb +42 -0
- data/spec/models/delete_alerts200_response_data_spec.rb +36 -0
- data/spec/models/delete_alerts200_response_spec.rb +42 -0
- data/spec/models/delete_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/delete_api_keys200_response_spec.rb +42 -0
- data/spec/models/delete_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/delete_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_asset_id_patch200_response_data_spec.rb → delete_assets200_response_data_spec.rb} +8 -8
- data/spec/models/delete_assets200_response_spec.rb +42 -0
- data/spec/models/delete_connections200_response_data_spec.rb +36 -0
- data/spec/models/delete_connections200_response_spec.rb +42 -0
- data/spec/models/delete_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/delete_endpoints200_response_spec.rb +42 -0
- data/spec/models/delete_favorites200_response_data_spec.rb +36 -0
- data/spec/models/delete_favorites200_response_spec.rb +42 -0
- data/spec/models/delete_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/delete_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/delete_posts200_response_data_spec.rb +36 -0
- data/spec/models/delete_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_patch200_response_data_spec.rb → delete_users200_response_data_spec.rb} +8 -8
- data/spec/models/delete_users200_response_spec.rb +42 -0
- data/spec/models/endpoints_input_spec.rb +236 -0
- data/spec/models/endpoints_spec.rb +242 -0
- data/spec/models/endpoints_update_spec.rb +236 -0
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/favorites_input_spec.rb +66 -0
- data/spec/models/{favorite_spec.rb → favorites_spec.rb} +17 -23
- data/spec/models/favorites_update_spec.rb +66 -0
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_get200_response_spec.rb → get_api_keys_by_id200_response_spec.rb} +8 -8
- data/spec/models/get_asset_price_history_by_id200_response_spec.rb +42 -0
- data/spec/models/get_asset_usecases_by_id200_response_spec.rb +42 -0
- data/spec/models/get_assets_by_id_analyze200_response_spec.rb +42 -0
- data/spec/models/get_cloud_providers_by_id200_response_spec.rb +42 -0
- data/spec/models/get_companies_by_id200_response_spec.rb +42 -0
- data/spec/models/get_connections_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_delete200_response_spec.rb → get_endpoints_by_id_connections_describe200_response_spec.rb} +8 -8
- data/spec/models/get_favorites_by_id200_response_spec.rb +42 -0
- data/spec/models/get_industries_by_id200_response_spec.rb +42 -0
- data/spec/models/get_job_functions_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_get200_response_spec.rb → get_postgen_integrations_by_id200_response_spec.rb} +8 -8
- data/spec/models/get_posts_by_id200_response_spec.rb +42 -0
- data/spec/models/get_storage_engines_by_id200_response_spec.rb +42 -0
- data/spec/models/get_users_by_id200_response_spec.rb +42 -0
- data/spec/models/industries_spec.rb +78 -0
- data/spec/models/inline_object1_spec.rb +3 -3
- data/spec/models/inline_object2_spec.rb +3 -3
- data/spec/models/inline_object3_spec.rb +3 -3
- data/spec/models/inline_object4_spec.rb +42 -0
- data/spec/models/inline_object5_spec.rb +42 -0
- data/spec/models/{companies_company_id_connections_get200_response_spec.rb → inline_object6_spec.rb} +15 -9
- data/spec/models/inline_object7_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +3 -3
- data/spec/models/job_functions_input_spec.rb +36 -0
- data/spec/models/job_functions_spec.rb +54 -0
- data/spec/models/job_functions_update_spec.rb +36 -0
- data/spec/models/list_api_keys200_response_spec.rb +42 -0
- data/spec/models/list_asset_usecases200_response_spec.rb +42 -0
- data/spec/models/list_assets200_response_spec.rb +42 -0
- data/spec/models/list_cloud_providers200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_api_keys_get200_response_spec.rb → list_companies_analytics_assets200_response_spec.rb} +8 -8
- data/spec/models/list_connections200_response_spec.rb +42 -0
- data/spec/models/list_endpoints200_response_spec.rb +42 -0
- data/spec/models/list_industries200_response_spec.rb +42 -0
- data/spec/models/list_job_functions200_response_spec.rb +42 -0
- data/spec/models/list_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/list_posts200_response_spec.rb +42 -0
- data/spec/models/list_storage_engines200_response_spec.rb +42 -0
- data/spec/models/list_users200_response_spec.rb +42 -0
- data/spec/models/post_publications_input_spec.rb +84 -0
- data/spec/models/post_publications_spec.rb +102 -0
- data/spec/models/post_publications_update_spec.rb +84 -0
- data/spec/models/postgen_integrations_input_spec.rb +72 -0
- data/spec/models/{alert_spec.rb → postgen_integrations_spec.rb} +17 -17
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/{connection_spec.rb → posts_input_spec.rb} +51 -27
- data/spec/models/posts_spec.rb +186 -0
- data/spec/models/posts_update_spec.rb +168 -0
- data/spec/models/storage_engines_spec.rb +82 -0
- data/spec/models/update_alerts200_response_data_spec.rb +36 -0
- data/spec/models/update_alerts200_response_spec.rb +42 -0
- data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/update_api_keys200_response_spec.rb +42 -0
- data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/update_assets200_response_data_spec.rb +36 -0
- data/spec/models/update_assets200_response_spec.rb +42 -0
- data/spec/models/update_companies200_response_data_spec.rb +36 -0
- data/spec/models/update_companies200_response_spec.rb +42 -0
- data/spec/models/update_connections200_response_data_spec.rb +36 -0
- data/spec/models/update_connections200_response_spec.rb +42 -0
- data/spec/models/update_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/update_endpoints200_response_spec.rb +42 -0
- data/spec/models/update_favorites200_response_data_spec.rb +36 -0
- data/spec/models/update_favorites200_response_spec.rb +42 -0
- data/spec/models/update_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/update_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/update_posts200_response_data_spec.rb +36 -0
- data/spec/models/update_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_delete200_response_data_spec.rb → update_users200_response_data_spec.rb} +8 -8
- data/spec/models/update_users200_response_spec.rb +42 -0
- data/spec/models/users_input_spec.rb +76 -0
- data/spec/models/{me_get200_response_profile_spec.rb → users_spec.rb} +22 -22
- data/spec/models/users_update_spec.rb +76 -0
- data/spec/spec_helper.rb +2 -2
- metadata +623 -283
- data/docs/Alert.md +0 -36
- data/docs/Apikey.md +0 -36
- data/docs/Asset.md +0 -110
- data/docs/Assetpricehistory.md +0 -38
- data/docs/Cloudprovider.md +0 -30
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +0 -20
- data/docs/Company.md +0 -44
- data/docs/Connection.md +0 -54
- data/docs/Favorite.md +0 -36
- data/docs/MeGet200Response.md +0 -36
- data/docs/MeGet200ResponseApiKeyInfo.md +0 -20
- data/docs/MeGet200ResponseProfile.md +0 -36
- data/docs/MeGet200ResponseTokenMetadata.md +0 -24
- data/docs/User.md +0 -34
- data/example.rb +0 -51
- data/lib/spartera_api_sdk/models/asset.rb +0 -686
- data/lib/spartera_api_sdk/models/assetpricehistory.rb +0 -345
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/me_get200_response.rb +0 -417
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +0 -42
- data/spec/models/me_get200_response_api_key_info_spec.rb +0 -42
data/docs/FavoritesApi.md
CHANGED
|
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
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
15
|
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## create_favorites
|
|
18
18
|
|
|
19
|
-
> <
|
|
19
|
+
> <CreateFavorites200Response> create_favorites(company_id, user_id, favorites_input)
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
POST /companies/{company_id}/users/{user_id}/favorites
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -34,34 +34,34 @@ SparteraApiSdk.configure do |config|
|
|
|
34
34
|
end
|
|
35
35
|
|
|
36
36
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
37
|
-
company_id = 'company_id_example' # String |
|
|
38
|
-
user_id = 'user_id_example' # String |
|
|
39
|
-
|
|
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
40
|
|
|
41
41
|
begin
|
|
42
|
-
#
|
|
43
|
-
result = api_instance.
|
|
42
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
|
43
|
+
result = api_instance.create_favorites(company_id, user_id, favorites_input)
|
|
44
44
|
p result
|
|
45
45
|
rescue SparteraApiSdk::ApiError => e
|
|
46
|
-
puts "Error when calling FavoritesApi->
|
|
46
|
+
puts "Error when calling FavoritesApi->create_favorites: #{e}"
|
|
47
47
|
end
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
#### Using the
|
|
50
|
+
#### Using the create_favorites_with_http_info variant
|
|
51
51
|
|
|
52
52
|
This returns an Array which contains the response data, status code and headers.
|
|
53
53
|
|
|
54
|
-
> <Array(<
|
|
54
|
+
> <Array(<CreateFavorites200Response>, Integer, Hash)> create_favorites_with_http_info(company_id, user_id, favorites_input)
|
|
55
55
|
|
|
56
56
|
```ruby
|
|
57
57
|
begin
|
|
58
|
-
#
|
|
59
|
-
data, status_code, headers = api_instance.
|
|
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
60
|
p status_code # => 2xx
|
|
61
61
|
p headers # => { ... }
|
|
62
|
-
p data # => <
|
|
62
|
+
p data # => <CreateFavorites200Response>
|
|
63
63
|
rescue SparteraApiSdk::ApiError => e
|
|
64
|
-
puts "Error when calling FavoritesApi->
|
|
64
|
+
puts "Error when calling FavoritesApi->create_favorites_with_http_info: #{e}"
|
|
65
65
|
end
|
|
66
66
|
```
|
|
67
67
|
|
|
@@ -69,13 +69,13 @@ end
|
|
|
69
69
|
|
|
70
70
|
| Name | Type | Description | Notes |
|
|
71
71
|
| ---- | ---- | ----------- | ----- |
|
|
72
|
-
| **company_id** | **String** |
|
|
73
|
-
| **user_id** | **String** |
|
|
74
|
-
| **
|
|
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
75
|
|
|
76
76
|
### Return type
|
|
77
77
|
|
|
78
|
-
[**
|
|
78
|
+
[**CreateFavorites200Response**](CreateFavorites200Response.md)
|
|
79
79
|
|
|
80
80
|
### Authorization
|
|
81
81
|
|
|
@@ -83,15 +83,15 @@ end
|
|
|
83
83
|
|
|
84
84
|
### HTTP request headers
|
|
85
85
|
|
|
86
|
-
- **Content-Type**:
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
87
|
- **Accept**: application/json
|
|
88
88
|
|
|
89
89
|
|
|
90
|
-
##
|
|
90
|
+
## delete_favorites
|
|
91
91
|
|
|
92
|
-
> <
|
|
92
|
+
> <DeleteFavorites200Response> delete_favorites(company_id, user_id, favorite_id)
|
|
93
93
|
|
|
94
|
-
|
|
94
|
+
Delete single favorite by ID (unfavorite an asset)
|
|
95
95
|
|
|
96
96
|
### Examples
|
|
97
97
|
|
|
@@ -107,34 +107,34 @@ SparteraApiSdk.configure do |config|
|
|
|
107
107
|
end
|
|
108
108
|
|
|
109
109
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
110
|
-
company_id = 'company_id_example' # String |
|
|
111
|
-
user_id = 'user_id_example' # String |
|
|
112
|
-
|
|
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
113
|
|
|
114
114
|
begin
|
|
115
|
-
#
|
|
116
|
-
result = api_instance.
|
|
115
|
+
# Delete single favorite by ID (unfavorite an asset)
|
|
116
|
+
result = api_instance.delete_favorites(company_id, user_id, favorite_id)
|
|
117
117
|
p result
|
|
118
118
|
rescue SparteraApiSdk::ApiError => e
|
|
119
|
-
puts "Error when calling FavoritesApi->
|
|
119
|
+
puts "Error when calling FavoritesApi->delete_favorites: #{e}"
|
|
120
120
|
end
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
#### Using the
|
|
123
|
+
#### Using the delete_favorites_with_http_info variant
|
|
124
124
|
|
|
125
125
|
This returns an Array which contains the response data, status code and headers.
|
|
126
126
|
|
|
127
|
-
> <Array(<
|
|
127
|
+
> <Array(<DeleteFavorites200Response>, Integer, Hash)> delete_favorites_with_http_info(company_id, user_id, favorite_id)
|
|
128
128
|
|
|
129
129
|
```ruby
|
|
130
130
|
begin
|
|
131
|
-
#
|
|
132
|
-
data, status_code, headers = api_instance.
|
|
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
133
|
p status_code # => 2xx
|
|
134
134
|
p headers # => { ... }
|
|
135
|
-
p data # => <
|
|
135
|
+
p data # => <DeleteFavorites200Response>
|
|
136
136
|
rescue SparteraApiSdk::ApiError => e
|
|
137
|
-
puts "Error when calling FavoritesApi->
|
|
137
|
+
puts "Error when calling FavoritesApi->delete_favorites_with_http_info: #{e}"
|
|
138
138
|
end
|
|
139
139
|
```
|
|
140
140
|
|
|
@@ -142,13 +142,13 @@ end
|
|
|
142
142
|
|
|
143
143
|
| Name | Type | Description | Notes |
|
|
144
144
|
| ---- | ---- | ----------- | ----- |
|
|
145
|
-
| **company_id** | **String** |
|
|
146
|
-
| **user_id** | **String** |
|
|
147
|
-
| **
|
|
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
148
|
|
|
149
149
|
### Return type
|
|
150
150
|
|
|
151
|
-
[**
|
|
151
|
+
[**DeleteFavorites200Response**](DeleteFavorites200Response.md)
|
|
152
152
|
|
|
153
153
|
### Authorization
|
|
154
154
|
|
|
@@ -160,11 +160,11 @@ end
|
|
|
160
160
|
- **Accept**: application/json
|
|
161
161
|
|
|
162
162
|
|
|
163
|
-
##
|
|
163
|
+
## get_favorites_by_id
|
|
164
164
|
|
|
165
|
-
> <
|
|
165
|
+
> <GetFavoritesById200Response> get_favorites_by_id(company_id, user_id)
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
Get a list of all favorites for a specific user
|
|
168
168
|
|
|
169
169
|
### Examples
|
|
170
170
|
|
|
@@ -180,34 +180,33 @@ SparteraApiSdk.configure do |config|
|
|
|
180
180
|
end
|
|
181
181
|
|
|
182
182
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
183
|
-
company_id = 'company_id_example' # String |
|
|
184
|
-
user_id = 'user_id_example' # String |
|
|
185
|
-
favorite_id = 'favorite_id_example' # String |
|
|
183
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
184
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
186
185
|
|
|
187
186
|
begin
|
|
188
|
-
#
|
|
189
|
-
result = api_instance.
|
|
187
|
+
# Get a list of all favorites for a specific user
|
|
188
|
+
result = api_instance.get_favorites_by_id(company_id, user_id)
|
|
190
189
|
p result
|
|
191
190
|
rescue SparteraApiSdk::ApiError => e
|
|
192
|
-
puts "Error when calling FavoritesApi->
|
|
191
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id: #{e}"
|
|
193
192
|
end
|
|
194
193
|
```
|
|
195
194
|
|
|
196
|
-
#### Using the
|
|
195
|
+
#### Using the get_favorites_by_id_with_http_info variant
|
|
197
196
|
|
|
198
197
|
This returns an Array which contains the response data, status code and headers.
|
|
199
198
|
|
|
200
|
-
> <Array(<
|
|
199
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_with_http_info(company_id, user_id)
|
|
201
200
|
|
|
202
201
|
```ruby
|
|
203
202
|
begin
|
|
204
|
-
#
|
|
205
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
206
205
|
p status_code # => 2xx
|
|
207
206
|
p headers # => { ... }
|
|
208
|
-
p data # => <
|
|
207
|
+
p data # => <GetFavoritesById200Response>
|
|
209
208
|
rescue SparteraApiSdk::ApiError => e
|
|
210
|
-
puts "Error when calling FavoritesApi->
|
|
209
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_with_http_info: #{e}"
|
|
211
210
|
end
|
|
212
211
|
```
|
|
213
212
|
|
|
@@ -215,13 +214,12 @@ end
|
|
|
215
214
|
|
|
216
215
|
| Name | Type | Description | Notes |
|
|
217
216
|
| ---- | ---- | ----------- | ----- |
|
|
218
|
-
| **company_id** | **String** |
|
|
219
|
-
| **user_id** | **String** |
|
|
220
|
-
| **favorite_id** | **String** | | |
|
|
217
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
218
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
221
219
|
|
|
222
220
|
### Return type
|
|
223
221
|
|
|
224
|
-
[**
|
|
222
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
225
223
|
|
|
226
224
|
### Authorization
|
|
227
225
|
|
|
@@ -233,9 +231,9 @@ end
|
|
|
233
231
|
- **Accept**: application/json
|
|
234
232
|
|
|
235
233
|
|
|
236
|
-
##
|
|
234
|
+
## get_favorites_by_id_users
|
|
237
235
|
|
|
238
|
-
> <
|
|
236
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users(company_id, user_id, favorite_id)
|
|
239
237
|
|
|
240
238
|
Get single favorite by ID
|
|
241
239
|
|
|
@@ -253,34 +251,34 @@ SparteraApiSdk.configure do |config|
|
|
|
253
251
|
end
|
|
254
252
|
|
|
255
253
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
256
|
-
company_id = 'company_id_example' # String |
|
|
257
|
-
user_id = 'user_id_example' # String |
|
|
258
|
-
favorite_id = 'favorite_id_example' # String |
|
|
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
|
|
259
257
|
|
|
260
258
|
begin
|
|
261
259
|
# Get single favorite by ID
|
|
262
|
-
result = api_instance.
|
|
260
|
+
result = api_instance.get_favorites_by_id_users(company_id, user_id, favorite_id)
|
|
263
261
|
p result
|
|
264
262
|
rescue SparteraApiSdk::ApiError => e
|
|
265
|
-
puts "Error when calling FavoritesApi->
|
|
263
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users: #{e}"
|
|
266
264
|
end
|
|
267
265
|
```
|
|
268
266
|
|
|
269
|
-
#### Using the
|
|
267
|
+
#### Using the get_favorites_by_id_users_with_http_info variant
|
|
270
268
|
|
|
271
269
|
This returns an Array which contains the response data, status code and headers.
|
|
272
270
|
|
|
273
|
-
> <Array(<
|
|
271
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
|
|
274
272
|
|
|
275
273
|
```ruby
|
|
276
274
|
begin
|
|
277
275
|
# Get single favorite by ID
|
|
278
|
-
data, status_code, headers = api_instance.
|
|
276
|
+
data, status_code, headers = api_instance.get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
|
|
279
277
|
p status_code # => 2xx
|
|
280
278
|
p headers # => { ... }
|
|
281
|
-
p data # => <
|
|
279
|
+
p data # => <GetFavoritesById200Response>
|
|
282
280
|
rescue SparteraApiSdk::ApiError => e
|
|
283
|
-
puts "Error when calling FavoritesApi->
|
|
281
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_with_http_info: #{e}"
|
|
284
282
|
end
|
|
285
283
|
```
|
|
286
284
|
|
|
@@ -288,13 +286,13 @@ end
|
|
|
288
286
|
|
|
289
287
|
| Name | Type | Description | Notes |
|
|
290
288
|
| ---- | ---- | ----------- | ----- |
|
|
291
|
-
| **company_id** | **String** |
|
|
292
|
-
| **user_id** | **String** |
|
|
293
|
-
| **favorite_id** | **String** |
|
|
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 | |
|
|
294
292
|
|
|
295
293
|
### Return type
|
|
296
294
|
|
|
297
|
-
[**
|
|
295
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
298
296
|
|
|
299
297
|
### Authorization
|
|
300
298
|
|
|
@@ -306,11 +304,11 @@ end
|
|
|
306
304
|
- **Accept**: application/json
|
|
307
305
|
|
|
308
306
|
|
|
309
|
-
##
|
|
307
|
+
## get_favorites_by_id_users_category
|
|
310
308
|
|
|
311
|
-
> <
|
|
309
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_category(company_id, user_id, category)
|
|
312
310
|
|
|
313
|
-
|
|
311
|
+
Get all favorites for the specified user in a specific category
|
|
314
312
|
|
|
315
313
|
### Examples
|
|
316
314
|
|
|
@@ -326,35 +324,34 @@ SparteraApiSdk.configure do |config|
|
|
|
326
324
|
end
|
|
327
325
|
|
|
328
326
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
329
|
-
company_id = 'company_id_example' # String |
|
|
330
|
-
user_id = 'user_id_example' # String |
|
|
331
|
-
|
|
332
|
-
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
|
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
|
|
333
330
|
|
|
334
331
|
begin
|
|
335
|
-
#
|
|
336
|
-
result = api_instance.
|
|
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)
|
|
337
334
|
p result
|
|
338
335
|
rescue SparteraApiSdk::ApiError => e
|
|
339
|
-
puts "Error when calling FavoritesApi->
|
|
336
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_category: #{e}"
|
|
340
337
|
end
|
|
341
338
|
```
|
|
342
339
|
|
|
343
|
-
#### Using the
|
|
340
|
+
#### Using the get_favorites_by_id_users_category_with_http_info variant
|
|
344
341
|
|
|
345
342
|
This returns an Array which contains the response data, status code and headers.
|
|
346
343
|
|
|
347
|
-
> <Array(<
|
|
344
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_category_with_http_info(company_id, user_id, category)
|
|
348
345
|
|
|
349
346
|
```ruby
|
|
350
347
|
begin
|
|
351
|
-
#
|
|
352
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
353
350
|
p status_code # => 2xx
|
|
354
351
|
p headers # => { ... }
|
|
355
|
-
p data # => <
|
|
352
|
+
p data # => <GetFavoritesById200Response>
|
|
356
353
|
rescue SparteraApiSdk::ApiError => e
|
|
357
|
-
puts "Error when calling FavoritesApi->
|
|
354
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_category_with_http_info: #{e}"
|
|
358
355
|
end
|
|
359
356
|
```
|
|
360
357
|
|
|
@@ -362,14 +359,13 @@ end
|
|
|
362
359
|
|
|
363
360
|
| Name | Type | Description | Notes |
|
|
364
361
|
| ---- | ---- | ----------- | ----- |
|
|
365
|
-
| **company_id** | **String** |
|
|
366
|
-
| **user_id** | **String** |
|
|
367
|
-
| **
|
|
368
|
-
| **favorite** | [**Favorite**](Favorite.md) | | |
|
|
362
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
363
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
364
|
+
| **category** | **String** | Parameter for category | |
|
|
369
365
|
|
|
370
366
|
### Return type
|
|
371
367
|
|
|
372
|
-
[**
|
|
368
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
373
369
|
|
|
374
370
|
### Authorization
|
|
375
371
|
|
|
@@ -377,15 +373,15 @@ end
|
|
|
377
373
|
|
|
378
374
|
### HTTP request headers
|
|
379
375
|
|
|
380
|
-
- **Content-Type**:
|
|
376
|
+
- **Content-Type**: Not defined
|
|
381
377
|
- **Accept**: application/json
|
|
382
378
|
|
|
383
379
|
|
|
384
|
-
##
|
|
380
|
+
## get_favorites_by_id_users_check
|
|
385
381
|
|
|
386
|
-
> <
|
|
382
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_check(company_id, user_id, asset_id)
|
|
387
383
|
|
|
388
|
-
|
|
384
|
+
Check if the specified user has favorited a specific asset
|
|
389
385
|
|
|
390
386
|
### Examples
|
|
391
387
|
|
|
@@ -401,33 +397,34 @@ SparteraApiSdk.configure do |config|
|
|
|
401
397
|
end
|
|
402
398
|
|
|
403
399
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
404
|
-
company_id = 'company_id_example' # String |
|
|
405
|
-
user_id = 'user_id_example' # String |
|
|
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
|
|
406
403
|
|
|
407
404
|
begin
|
|
408
|
-
#
|
|
409
|
-
result = api_instance.
|
|
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)
|
|
410
407
|
p result
|
|
411
408
|
rescue SparteraApiSdk::ApiError => e
|
|
412
|
-
puts "Error when calling FavoritesApi->
|
|
409
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_check: #{e}"
|
|
413
410
|
end
|
|
414
411
|
```
|
|
415
412
|
|
|
416
|
-
#### Using the
|
|
413
|
+
#### Using the get_favorites_by_id_users_check_with_http_info variant
|
|
417
414
|
|
|
418
415
|
This returns an Array which contains the response data, status code and headers.
|
|
419
416
|
|
|
420
|
-
> <Array(<
|
|
417
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_check_with_http_info(company_id, user_id, asset_id)
|
|
421
418
|
|
|
422
419
|
```ruby
|
|
423
420
|
begin
|
|
424
|
-
#
|
|
425
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
426
423
|
p status_code # => 2xx
|
|
427
424
|
p headers # => { ... }
|
|
428
|
-
p data # => <
|
|
425
|
+
p data # => <GetFavoritesById200Response>
|
|
429
426
|
rescue SparteraApiSdk::ApiError => e
|
|
430
|
-
puts "Error when calling FavoritesApi->
|
|
427
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_check_with_http_info: #{e}"
|
|
431
428
|
end
|
|
432
429
|
```
|
|
433
430
|
|
|
@@ -435,12 +432,13 @@ end
|
|
|
435
432
|
|
|
436
433
|
| Name | Type | Description | Notes |
|
|
437
434
|
| ---- | ---- | ----------- | ----- |
|
|
438
|
-
| **company_id** | **String** |
|
|
439
|
-
| **user_id** | **String** |
|
|
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 | |
|
|
440
438
|
|
|
441
439
|
### Return type
|
|
442
440
|
|
|
443
|
-
[**
|
|
441
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
444
442
|
|
|
445
443
|
### Authorization
|
|
446
444
|
|
|
@@ -452,11 +450,11 @@ end
|
|
|
452
450
|
- **Accept**: application/json
|
|
453
451
|
|
|
454
452
|
|
|
455
|
-
##
|
|
453
|
+
## get_favorites_by_id_users_uncategorized
|
|
456
454
|
|
|
457
|
-
> <
|
|
455
|
+
> <GetFavoritesById200Response> get_favorites_by_id_users_uncategorized(company_id, user_id)
|
|
458
456
|
|
|
459
|
-
|
|
457
|
+
Get all favorites for the specified user that don't have a category
|
|
460
458
|
|
|
461
459
|
### Examples
|
|
462
460
|
|
|
@@ -472,34 +470,33 @@ SparteraApiSdk.configure do |config|
|
|
|
472
470
|
end
|
|
473
471
|
|
|
474
472
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
475
|
-
company_id = 'company_id_example' # String |
|
|
476
|
-
user_id = 'user_id_example' # String |
|
|
477
|
-
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
|
473
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
474
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
478
475
|
|
|
479
476
|
begin
|
|
480
|
-
#
|
|
481
|
-
result = api_instance.
|
|
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)
|
|
482
479
|
p result
|
|
483
480
|
rescue SparteraApiSdk::ApiError => e
|
|
484
|
-
puts "Error when calling FavoritesApi->
|
|
481
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized: #{e}"
|
|
485
482
|
end
|
|
486
483
|
```
|
|
487
484
|
|
|
488
|
-
#### Using the
|
|
485
|
+
#### Using the get_favorites_by_id_users_uncategorized_with_http_info variant
|
|
489
486
|
|
|
490
487
|
This returns an Array which contains the response data, status code and headers.
|
|
491
488
|
|
|
492
|
-
> <Array(<
|
|
489
|
+
> <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_uncategorized_with_http_info(company_id, user_id)
|
|
493
490
|
|
|
494
491
|
```ruby
|
|
495
492
|
begin
|
|
496
|
-
#
|
|
497
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
498
495
|
p status_code # => 2xx
|
|
499
496
|
p headers # => { ... }
|
|
500
|
-
p data # => <
|
|
497
|
+
p data # => <GetFavoritesById200Response>
|
|
501
498
|
rescue SparteraApiSdk::ApiError => e
|
|
502
|
-
puts "Error when calling FavoritesApi->
|
|
499
|
+
puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized_with_http_info: #{e}"
|
|
503
500
|
end
|
|
504
501
|
```
|
|
505
502
|
|
|
@@ -507,13 +504,12 @@ end
|
|
|
507
504
|
|
|
508
505
|
| Name | Type | Description | Notes |
|
|
509
506
|
| ---- | ---- | ----------- | ----- |
|
|
510
|
-
| **company_id** | **String** |
|
|
511
|
-
| **user_id** | **String** |
|
|
512
|
-
| **favorite** | [**Favorite**](Favorite.md) | | |
|
|
507
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
508
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
513
509
|
|
|
514
510
|
### Return type
|
|
515
511
|
|
|
516
|
-
[**
|
|
512
|
+
[**GetFavoritesById200Response**](GetFavoritesById200Response.md)
|
|
517
513
|
|
|
518
514
|
### Authorization
|
|
519
515
|
|
|
@@ -521,15 +517,15 @@ end
|
|
|
521
517
|
|
|
522
518
|
### HTTP request headers
|
|
523
519
|
|
|
524
|
-
- **Content-Type**:
|
|
520
|
+
- **Content-Type**: Not defined
|
|
525
521
|
- **Accept**: application/json
|
|
526
522
|
|
|
527
523
|
|
|
528
|
-
##
|
|
524
|
+
## update_favorites
|
|
529
525
|
|
|
530
|
-
> <
|
|
526
|
+
> <UpdateFavorites200Response> update_favorites(company_id, user_id, favorite_id, favorites_update)
|
|
531
527
|
|
|
532
|
-
|
|
528
|
+
Update an existing favorite by ID
|
|
533
529
|
|
|
534
530
|
### Examples
|
|
535
531
|
|
|
@@ -545,33 +541,35 @@ SparteraApiSdk.configure do |config|
|
|
|
545
541
|
end
|
|
546
542
|
|
|
547
543
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
548
|
-
company_id = 'company_id_example' # String |
|
|
549
|
-
user_id = 'user_id_example' # String |
|
|
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 |
|
|
550
548
|
|
|
551
549
|
begin
|
|
552
|
-
#
|
|
553
|
-
result = api_instance.
|
|
550
|
+
# Update an existing favorite by ID
|
|
551
|
+
result = api_instance.update_favorites(company_id, user_id, favorite_id, favorites_update)
|
|
554
552
|
p result
|
|
555
553
|
rescue SparteraApiSdk::ApiError => e
|
|
556
|
-
puts "Error when calling FavoritesApi->
|
|
554
|
+
puts "Error when calling FavoritesApi->update_favorites: #{e}"
|
|
557
555
|
end
|
|
558
556
|
```
|
|
559
557
|
|
|
560
|
-
#### Using the
|
|
558
|
+
#### Using the update_favorites_with_http_info variant
|
|
561
559
|
|
|
562
560
|
This returns an Array which contains the response data, status code and headers.
|
|
563
561
|
|
|
564
|
-
> <Array(<
|
|
562
|
+
> <Array(<UpdateFavorites200Response>, Integer, Hash)> update_favorites_with_http_info(company_id, user_id, favorite_id, favorites_update)
|
|
565
563
|
|
|
566
564
|
```ruby
|
|
567
565
|
begin
|
|
568
|
-
#
|
|
569
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
570
568
|
p status_code # => 2xx
|
|
571
569
|
p headers # => { ... }
|
|
572
|
-
p data # => <
|
|
570
|
+
p data # => <UpdateFavorites200Response>
|
|
573
571
|
rescue SparteraApiSdk::ApiError => e
|
|
574
|
-
puts "Error when calling FavoritesApi->
|
|
572
|
+
puts "Error when calling FavoritesApi->update_favorites_with_http_info: #{e}"
|
|
575
573
|
end
|
|
576
574
|
```
|
|
577
575
|
|
|
@@ -579,12 +577,14 @@ end
|
|
|
579
577
|
|
|
580
578
|
| Name | Type | Description | Notes |
|
|
581
579
|
| ---- | ---- | ----------- | ----- |
|
|
582
|
-
| **company_id** | **String** |
|
|
583
|
-
| **user_id** | **String** |
|
|
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
584
|
|
|
585
585
|
### Return type
|
|
586
586
|
|
|
587
|
-
[**
|
|
587
|
+
[**UpdateFavorites200Response**](UpdateFavorites200Response.md)
|
|
588
588
|
|
|
589
589
|
### Authorization
|
|
590
590
|
|
|
@@ -592,6 +592,6 @@ end
|
|
|
592
592
|
|
|
593
593
|
### HTTP request headers
|
|
594
594
|
|
|
595
|
-
- **Content-Type**:
|
|
595
|
+
- **Content-Type**: application/json
|
|
596
596
|
- **Accept**: application/json
|
|
597
597
|
|