spartera_api_sdk 0.3.7 → 1.0.58
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/Gemfile +5 -3
- data/Gemfile.lock +69 -0
- data/README.md +324 -336
- data/config.json +10 -0
- data/docs/APIKeysApi.md +102 -286
- data/docs/Alert.md +36 -0
- data/docs/AlertsApi.md +163 -177
- data/docs/Apikey.md +36 -0
- data/docs/Asset.md +110 -0
- data/docs/AssetPriceHistoryApi.md +178 -202
- data/docs/Assetpricehistory.md +38 -0
- data/docs/AssetsApi.md +352 -418
- data/docs/CloudProvidersApi.md +233 -49
- data/docs/Cloudprovider.md +30 -0
- data/docs/CompaniesApi.md +171 -357
- data/docs/Company.md +44 -0
- data/docs/Connection.md +54 -0
- data/docs/ConnectionsApi.md +139 -249
- data/docs/Favorite.md +36 -0
- data/docs/FavoritesApi.md +183 -199
- data/docs/User.md +34 -0
- data/docs/UsersApi.md +97 -379
- data/example.rb +51 -0
- data/git_push.sh +2 -2
- data/lib/spartera_api_sdk/api/alerts_api.rb +176 -423
- data/lib/spartera_api_sdk/api/api_keys_api.rb +95 -496
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +177 -468
- data/lib/spartera_api_sdk/api/assets_api.rb +358 -806
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +199 -74
- data/lib/spartera_api_sdk/api/companies_api.rb +146 -660
- data/lib/spartera_api_sdk/api/connections_api.rb +139 -466
- data/lib/spartera_api_sdk/api/favorites_api.rb +204 -464
- data/lib/spartera_api_sdk/api/users_api.rb +95 -619
- data/lib/spartera_api_sdk/api_client.rb +4 -8
- data/lib/spartera_api_sdk/api_error.rb +2 -2
- data/lib/spartera_api_sdk/configuration.rb +12 -4
- data/lib/spartera_api_sdk/models/{alerts.rb → alert.rb} +139 -46
- data/lib/spartera_api_sdk/models/{api_keys.rb → apikey.rb} +124 -98
- data/lib/spartera_api_sdk/models/asset.rb +686 -0
- data/lib/spartera_api_sdk/models/{asset_price_history.rb → assetpricehistory.rb} +180 -44
- data/lib/spartera_api_sdk/models/{cloud_providers.rb → cloudprovider.rb} +111 -35
- data/lib/spartera_api_sdk/models/{companies.rb → company.rb} +105 -90
- data/lib/spartera_api_sdk/models/{connections.rb → connection.rb} +186 -69
- data/lib/spartera_api_sdk/models/error.rb +76 -3
- data/lib/spartera_api_sdk/models/{favorites.rb → favorite.rb} +111 -38
- data/lib/spartera_api_sdk/models/inline_object.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object1.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object2.rb +76 -3
- data/lib/spartera_api_sdk/models/inline_object3.rb +76 -3
- data/lib/spartera_api_sdk/models/{users.rb → user.rb} +108 -112
- data/lib/spartera_api_sdk/version.rb +3 -3
- data/lib/spartera_api_sdk.rb +11 -150
- data/spartera_api_sdk.gemspec +8 -19
- data/spec/api/alerts_api_spec.rb +51 -51
- data/spec/api/api_keys_api_spec.rb +30 -67
- data/spec/api/asset_price_history_api_spec.rb +53 -57
- data/spec/api/assets_api_spec.rb +99 -114
- data/spec/api/cloud_providers_api_spec.rb +42 -15
- data/spec/api/companies_api_spec.rb +47 -99
- data/spec/api/connections_api_spec.rb +41 -63
- data/spec/api/favorites_api_spec.rb +56 -56
- data/spec/api/users_api_spec.rb +29 -88
- data/spec/models/{postgen_integrations_spec.rb → alert_spec.rb} +17 -17
- data/spec/models/{api_keys_update_spec.rb → apikey_spec.rb} +20 -14
- data/spec/models/{endpoints_spec.rb → asset_spec.rb} +83 -69
- data/spec/models/{api_keys_spec.rb → assetpricehistory_spec.rb} +19 -25
- data/spec/models/{cloud_providers_spec.rb → cloudprovider_spec.rb} +20 -14
- data/spec/models/{companies_spec.rb → company_spec.rb} +16 -26
- data/spec/models/{posts_input_spec.rb → connection_spec.rb} +27 -51
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/{favorites_spec.rb → favorite_spec.rb} +23 -17
- 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_object_spec.rb +3 -3
- data/spec/models/{api_keys_input_spec.rb → user_spec.rb} +15 -15
- data/spec/spec_helper.rb +2 -2
- data/test.sh +42 -0
- metadata +77 -615
- data/CHANGELOG.md +0 -13
- data/docs/Alerts.md +0 -30
- data/docs/AlertsInput.md +0 -24
- data/docs/AlertsUpdate.md +0 -24
- data/docs/ApiKeys.md +0 -40
- data/docs/ApiKeysInput.md +0 -34
- data/docs/ApiKeysUpdate.md +0 -34
- data/docs/AssetPriceHistory.md +0 -30
- data/docs/AssetPriceHistoryInput.md +0 -24
- data/docs/AssetPriceHistoryUpdate.md +0 -24
- data/docs/AssetUsecases.md +0 -28
- data/docs/AssetUsecasesApi.md +0 -157
- data/docs/Assets.md +0 -142
- data/docs/AssetsInput.md +0 -128
- data/docs/AssetsUpdate.md +0 -128
- data/docs/CloudProviders.md +0 -28
- data/docs/CloudProvidersInput.md +0 -22
- data/docs/CloudProvidersUpdate.md +0 -22
- data/docs/Companies.md +0 -46
- data/docs/CompaniesInput.md +0 -40
- data/docs/CompaniesUpdate.md +0 -40
- data/docs/Connections.md +0 -38
- data/docs/ConnectionsInput.md +0 -32
- data/docs/ConnectionsUpdate.md +0 -32
- data/docs/CreateAlerts200Response.md +0 -20
- data/docs/CreateAlerts200ResponseData.md +0 -18
- data/docs/CreateApiKeys200Response.md +0 -20
- data/docs/CreateApiKeys200ResponseData.md +0 -18
- data/docs/CreateAssetPriceHistory200Response.md +0 -20
- data/docs/CreateAssetPriceHistory200ResponseData.md +0 -18
- data/docs/CreateAssetsAnalyze200Response.md +0 -20
- data/docs/CreateAssetsAnalyze200ResponseData.md +0 -18
- data/docs/CreateConnections200Response.md +0 -20
- data/docs/CreateConnections200ResponseData.md +0 -18
- data/docs/CreateEndpoints200Response.md +0 -20
- data/docs/CreateEndpoints200ResponseData.md +0 -18
- data/docs/CreateFavorites200Response.md +0 -20
- data/docs/CreateFavorites200ResponseData.md +0 -18
- data/docs/CreatePostgenIntegrations200Response.md +0 -20
- data/docs/CreatePostgenIntegrations200ResponseData.md +0 -18
- data/docs/CreatePosts200Response.md +0 -20
- data/docs/CreatePosts200ResponseData.md +0 -18
- data/docs/CreateUsers200Response.md +0 -20
- data/docs/CreateUsers200ResponseData.md +0 -18
- data/docs/DeleteAlerts200Response.md +0 -20
- data/docs/DeleteAlerts200ResponseData.md +0 -18
- data/docs/DeleteApiKeys200Response.md +0 -20
- data/docs/DeleteApiKeys200ResponseData.md +0 -18
- data/docs/DeleteAssetPriceHistory200Response.md +0 -20
- data/docs/DeleteAssetPriceHistory200ResponseData.md +0 -18
- data/docs/DeleteAssets200Response.md +0 -20
- data/docs/DeleteAssets200ResponseData.md +0 -18
- data/docs/DeleteConnections200Response.md +0 -20
- data/docs/DeleteConnections200ResponseData.md +0 -18
- data/docs/DeleteEndpoints200Response.md +0 -20
- data/docs/DeleteEndpoints200ResponseData.md +0 -18
- data/docs/DeleteFavorites200Response.md +0 -20
- data/docs/DeleteFavorites200ResponseData.md +0 -18
- data/docs/DeletePostgenIntegrations200Response.md +0 -20
- data/docs/DeletePostgenIntegrations200ResponseData.md +0 -18
- data/docs/DeletePosts200Response.md +0 -20
- data/docs/DeletePosts200ResponseData.md +0 -18
- data/docs/DeleteUsers200Response.md +0 -20
- data/docs/DeleteUsers200ResponseData.md +0 -18
- data/docs/Endpoints.md +0 -96
- data/docs/EndpointsApi.md +0 -1189
- data/docs/EndpointsInput.md +0 -94
- data/docs/EndpointsUpdate.md +0 -94
- data/docs/Favorites.md +0 -34
- data/docs/FavoritesInput.md +0 -28
- data/docs/FavoritesUpdate.md +0 -28
- data/docs/GetAlertsById200Response.md +0 -20
- data/docs/GetApiKeysById200Response.md +0 -20
- data/docs/GetAssetPriceHistoryById200Response.md +0 -20
- data/docs/GetAssetUsecasesById200Response.md +0 -20
- data/docs/GetAssetsByIdAnalyze200Response.md +0 -20
- data/docs/GetCloudProvidersById200Response.md +0 -20
- data/docs/GetCompaniesById200Response.md +0 -20
- data/docs/GetConnectionsById200Response.md +0 -20
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +0 -20
- data/docs/GetFavoritesById200Response.md +0 -20
- data/docs/GetIndustriesById200Response.md +0 -20
- data/docs/GetJobFunctionsById200Response.md +0 -20
- data/docs/GetPostgenIntegrationsById200Response.md +0 -20
- data/docs/GetPostsById200Response.md +0 -20
- data/docs/GetStorageEnginesById200Response.md +0 -20
- data/docs/GetUsersById200Response.md +0 -20
- data/docs/Industries.md +0 -32
- data/docs/IndustriesApi.md +0 -237
- data/docs/InlineObject4.md +0 -20
- data/docs/InlineObject5.md +0 -20
- data/docs/InlineObject6.md +0 -22
- data/docs/InlineObject7.md +0 -20
- data/docs/JobFunctions.md +0 -24
- data/docs/JobFunctionsApi.md +0 -157
- data/docs/JobFunctionsInput.md +0 -18
- data/docs/JobFunctionsUpdate.md +0 -18
- data/docs/ListApiKeys200Response.md +0 -20
- data/docs/ListAssetUsecases200Response.md +0 -20
- data/docs/ListAssets200Response.md +0 -20
- data/docs/ListCloudProviders200Response.md +0 -20
- data/docs/ListCompaniesAnalyticsAssets200Response.md +0 -20
- data/docs/ListConnections200Response.md +0 -20
- data/docs/ListEndpoints200Response.md +0 -20
- data/docs/ListIndustries200Response.md +0 -20
- data/docs/ListJobFunctions200Response.md +0 -20
- data/docs/ListPostgenIntegrations200Response.md +0 -20
- data/docs/ListPosts200Response.md +0 -20
- data/docs/ListStorageEngines200Response.md +0 -20
- data/docs/ListUsers200Response.md +0 -20
- data/docs/PostPublications.md +0 -40
- data/docs/PostPublicationsInput.md +0 -34
- data/docs/PostPublicationsUpdate.md +0 -34
- data/docs/PostgenIntegrations.md +0 -36
- data/docs/PostgenIntegrationsApi.md +0 -463
- data/docs/PostgenIntegrationsInput.md +0 -30
- data/docs/PostgenIntegrationsUpdate.md +0 -30
- data/docs/Posts.md +0 -68
- data/docs/PostsApi.md +0 -843
- data/docs/PostsInput.md +0 -62
- data/docs/PostsUpdate.md +0 -62
- data/docs/StorageEngines.md +0 -32
- data/docs/StorageEnginesApi.md +0 -161
- data/docs/UpdateAlerts200Response.md +0 -20
- data/docs/UpdateAlerts200ResponseData.md +0 -18
- data/docs/UpdateApiKeys200Response.md +0 -20
- data/docs/UpdateApiKeys200ResponseData.md +0 -18
- data/docs/UpdateAssetPriceHistory200Response.md +0 -20
- data/docs/UpdateAssetPriceHistory200ResponseData.md +0 -18
- data/docs/UpdateAssets200Response.md +0 -20
- data/docs/UpdateAssets200ResponseData.md +0 -18
- data/docs/UpdateCompanies200Response.md +0 -20
- data/docs/UpdateCompanies200ResponseData.md +0 -18
- data/docs/UpdateConnections200Response.md +0 -20
- data/docs/UpdateConnections200ResponseData.md +0 -18
- data/docs/UpdateEndpoints200Response.md +0 -20
- data/docs/UpdateEndpoints200ResponseData.md +0 -18
- data/docs/UpdateFavorites200Response.md +0 -20
- data/docs/UpdateFavorites200ResponseData.md +0 -18
- data/docs/UpdatePostgenIntegrations200Response.md +0 -20
- data/docs/UpdatePostgenIntegrations200ResponseData.md +0 -18
- data/docs/UpdatePosts200Response.md +0 -20
- data/docs/UpdatePosts200ResponseData.md +0 -18
- data/docs/UpdateUsers200Response.md +0 -20
- data/docs/UpdateUsers200ResponseData.md +0 -18
- data/docs/Users.md +0 -36
- data/docs/UsersInput.md +0 -30
- data/docs/UsersUpdate.md +0 -30
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +0 -190
- data/lib/spartera_api_sdk/api/endpoints_api.rb +0 -1613
- data/lib/spartera_api_sdk/api/industries_api.rb +0 -284
- data/lib/spartera_api_sdk/api/job_functions_api.rb +0 -190
- data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +0 -634
- data/lib/spartera_api_sdk/api/posts_api.rb +0 -1190
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +0 -228
- data/lib/spartera_api_sdk/api_model_base.rb +0 -88
- data/lib/spartera_api_sdk/models/alerts_input.rb +0 -213
- data/lib/spartera_api_sdk/models/alerts_update.rb +0 -179
- data/lib/spartera_api_sdk/models/api_keys_input.rb +0 -263
- data/lib/spartera_api_sdk/models/api_keys_update.rb +0 -229
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +0 -179
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +0 -179
- data/lib/spartera_api_sdk/models/asset_usecases.rb +0 -216
- data/lib/spartera_api_sdk/models/assets.rb +0 -1068
- data/lib/spartera_api_sdk/models/assets_input.rb +0 -918
- data/lib/spartera_api_sdk/models/assets_update.rb +0 -877
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +0 -186
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +0 -169
- data/lib/spartera_api_sdk/models/companies_input.rb +0 -327
- data/lib/spartera_api_sdk/models/companies_update.rb +0 -293
- data/lib/spartera_api_sdk/models/connections_input.rb +0 -287
- data/lib/spartera_api_sdk/models/connections_update.rb +0 -253
- data/lib/spartera_api_sdk/models/create_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/create_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/create_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_assets200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_assets200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/delete_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/delete_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/endpoints.rb +0 -788
- data/lib/spartera_api_sdk/models/endpoints_input.rb +0 -686
- data/lib/spartera_api_sdk/models/endpoints_update.rb +0 -635
- data/lib/spartera_api_sdk/models/favorites_input.rb +0 -233
- data/lib/spartera_api_sdk/models/favorites_update.rb +0 -199
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_endpoints_by_id_connections_describe200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_postgen_integrations_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/industries.rb +0 -253
- data/lib/spartera_api_sdk/models/inline_object4.rb +0 -156
- data/lib/spartera_api_sdk/models/inline_object5.rb +0 -156
- data/lib/spartera_api_sdk/models/inline_object6.rb +0 -166
- data/lib/spartera_api_sdk/models/inline_object7.rb +0 -156
- data/lib/spartera_api_sdk/models/job_functions.rb +0 -213
- data/lib/spartera_api_sdk/models/job_functions_input.rb +0 -166
- data/lib/spartera_api_sdk/models/job_functions_update.rb +0 -149
- data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_asset_usecases200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_assets200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_companies_analytics_assets200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_connections200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_industries200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_posts200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/list_users200_response.rb +0 -193
- data/lib/spartera_api_sdk/models/post_publications.rb +0 -327
- data/lib/spartera_api_sdk/models/post_publications_input.rb +0 -280
- data/lib/spartera_api_sdk/models/post_publications_update.rb +0 -229
- data/lib/spartera_api_sdk/models/postgen_integrations.rb +0 -341
- data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +0 -294
- data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +0 -209
- data/lib/spartera_api_sdk/models/posts.rb +0 -586
- data/lib/spartera_api_sdk/models/posts_input.rb +0 -437
- data/lib/spartera_api_sdk/models/posts_update.rb +0 -369
- data/lib/spartera_api_sdk/models/storage_engines.rb +0 -294
- data/lib/spartera_api_sdk/models/update_alerts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_alerts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_assets200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_assets200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_companies200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_connections200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_connections200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_favorites200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_favorites200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_posts200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/update_users200_response.rb +0 -191
- data/lib/spartera_api_sdk/models/update_users200_response_data.rb +0 -165
- data/lib/spartera_api_sdk/models/users_input.rb +0 -260
- data/lib/spartera_api_sdk/models/users_update.rb +0 -243
- data/spec/api/asset_usecases_api_spec.rb +0 -61
- data/spec/api/endpoints_api_spec.rb +0 -240
- data/spec/api/industries_api_spec.rb +0 -76
- data/spec/api/job_functions_api_spec.rb +0 -61
- data/spec/api/postgen_integrations_api_spec.rb +0 -117
- data/spec/api/posts_api_spec.rb +0 -186
- data/spec/api/storage_engines_api_spec.rb +0 -63
- data/spec/models/alerts_input_spec.rb +0 -54
- data/spec/models/alerts_spec.rb +0 -72
- data/spec/models/alerts_update_spec.rb +0 -54
- data/spec/models/asset_price_history_input_spec.rb +0 -54
- data/spec/models/asset_price_history_spec.rb +0 -72
- data/spec/models/asset_price_history_update_spec.rb +0 -54
- data/spec/models/asset_usecases_spec.rb +0 -66
- data/spec/models/assets_input_spec.rb +0 -418
- data/spec/models/assets_spec.rb +0 -464
- data/spec/models/assets_update_spec.rb +0 -418
- data/spec/models/cloud_providers_input_spec.rb +0 -48
- data/spec/models/cloud_providers_update_spec.rb +0 -48
- data/spec/models/companies_input_spec.rb +0 -106
- data/spec/models/companies_update_spec.rb +0 -106
- data/spec/models/connections_input_spec.rb +0 -82
- data/spec/models/connections_spec.rb +0 -100
- data/spec/models/connections_update_spec.rb +0 -82
- data/spec/models/create_alerts200_response_data_spec.rb +0 -36
- data/spec/models/create_alerts200_response_spec.rb +0 -42
- data/spec/models/create_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/create_api_keys200_response_spec.rb +0 -42
- data/spec/models/create_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/create_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/create_assets_analyze200_response_data_spec.rb +0 -36
- data/spec/models/create_assets_analyze200_response_spec.rb +0 -42
- data/spec/models/create_connections200_response_data_spec.rb +0 -36
- data/spec/models/create_connections200_response_spec.rb +0 -42
- data/spec/models/create_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/create_endpoints200_response_spec.rb +0 -42
- data/spec/models/create_favorites200_response_data_spec.rb +0 -36
- data/spec/models/create_favorites200_response_spec.rb +0 -42
- data/spec/models/create_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/create_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/create_posts200_response_data_spec.rb +0 -36
- data/spec/models/create_posts200_response_spec.rb +0 -42
- data/spec/models/create_users200_response_data_spec.rb +0 -36
- data/spec/models/create_users200_response_spec.rb +0 -42
- data/spec/models/delete_alerts200_response_data_spec.rb +0 -36
- data/spec/models/delete_alerts200_response_spec.rb +0 -42
- data/spec/models/delete_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/delete_api_keys200_response_spec.rb +0 -42
- data/spec/models/delete_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/delete_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/delete_assets200_response_data_spec.rb +0 -36
- data/spec/models/delete_assets200_response_spec.rb +0 -42
- data/spec/models/delete_connections200_response_data_spec.rb +0 -36
- data/spec/models/delete_connections200_response_spec.rb +0 -42
- data/spec/models/delete_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/delete_endpoints200_response_spec.rb +0 -42
- data/spec/models/delete_favorites200_response_data_spec.rb +0 -36
- data/spec/models/delete_favorites200_response_spec.rb +0 -42
- data/spec/models/delete_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/delete_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/delete_posts200_response_data_spec.rb +0 -36
- data/spec/models/delete_posts200_response_spec.rb +0 -42
- data/spec/models/delete_users200_response_data_spec.rb +0 -36
- data/spec/models/delete_users200_response_spec.rb +0 -42
- data/spec/models/endpoints_input_spec.rb +0 -292
- data/spec/models/endpoints_update_spec.rb +0 -292
- data/spec/models/favorites_input_spec.rb +0 -66
- data/spec/models/favorites_update_spec.rb +0 -66
- data/spec/models/get_alerts_by_id200_response_spec.rb +0 -42
- data/spec/models/get_api_keys_by_id200_response_spec.rb +0 -42
- data/spec/models/get_asset_price_history_by_id200_response_spec.rb +0 -42
- data/spec/models/get_asset_usecases_by_id200_response_spec.rb +0 -42
- data/spec/models/get_assets_by_id_analyze200_response_spec.rb +0 -42
- data/spec/models/get_cloud_providers_by_id200_response_spec.rb +0 -42
- data/spec/models/get_companies_by_id200_response_spec.rb +0 -42
- data/spec/models/get_connections_by_id200_response_spec.rb +0 -42
- data/spec/models/get_endpoints_by_id_connections_describe200_response_spec.rb +0 -42
- data/spec/models/get_favorites_by_id200_response_spec.rb +0 -42
- data/spec/models/get_industries_by_id200_response_spec.rb +0 -42
- data/spec/models/get_job_functions_by_id200_response_spec.rb +0 -42
- data/spec/models/get_postgen_integrations_by_id200_response_spec.rb +0 -42
- data/spec/models/get_posts_by_id200_response_spec.rb +0 -42
- data/spec/models/get_storage_engines_by_id200_response_spec.rb +0 -42
- data/spec/models/get_users_by_id200_response_spec.rb +0 -42
- data/spec/models/industries_spec.rb +0 -78
- data/spec/models/inline_object4_spec.rb +0 -42
- data/spec/models/inline_object5_spec.rb +0 -42
- data/spec/models/inline_object6_spec.rb +0 -48
- data/spec/models/inline_object7_spec.rb +0 -42
- data/spec/models/job_functions_input_spec.rb +0 -36
- data/spec/models/job_functions_spec.rb +0 -54
- data/spec/models/job_functions_update_spec.rb +0 -36
- data/spec/models/list_api_keys200_response_spec.rb +0 -42
- data/spec/models/list_asset_usecases200_response_spec.rb +0 -42
- data/spec/models/list_assets200_response_spec.rb +0 -42
- data/spec/models/list_cloud_providers200_response_spec.rb +0 -42
- data/spec/models/list_companies_analytics_assets200_response_spec.rb +0 -42
- data/spec/models/list_connections200_response_spec.rb +0 -42
- data/spec/models/list_endpoints200_response_spec.rb +0 -42
- data/spec/models/list_industries200_response_spec.rb +0 -42
- data/spec/models/list_job_functions200_response_spec.rb +0 -42
- data/spec/models/list_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/list_posts200_response_spec.rb +0 -42
- data/spec/models/list_storage_engines200_response_spec.rb +0 -42
- data/spec/models/list_users200_response_spec.rb +0 -42
- data/spec/models/post_publications_input_spec.rb +0 -84
- data/spec/models/post_publications_spec.rb +0 -102
- data/spec/models/post_publications_update_spec.rb +0 -84
- data/spec/models/postgen_integrations_input_spec.rb +0 -72
- data/spec/models/postgen_integrations_update_spec.rb +0 -72
- data/spec/models/posts_spec.rb +0 -186
- data/spec/models/posts_update_spec.rb +0 -168
- data/spec/models/storage_engines_spec.rb +0 -82
- data/spec/models/update_alerts200_response_data_spec.rb +0 -36
- data/spec/models/update_alerts200_response_spec.rb +0 -42
- data/spec/models/update_api_keys200_response_data_spec.rb +0 -36
- data/spec/models/update_api_keys200_response_spec.rb +0 -42
- data/spec/models/update_asset_price_history200_response_data_spec.rb +0 -36
- data/spec/models/update_asset_price_history200_response_spec.rb +0 -42
- data/spec/models/update_assets200_response_data_spec.rb +0 -36
- data/spec/models/update_assets200_response_spec.rb +0 -42
- data/spec/models/update_companies200_response_data_spec.rb +0 -36
- data/spec/models/update_companies200_response_spec.rb +0 -42
- data/spec/models/update_connections200_response_data_spec.rb +0 -36
- data/spec/models/update_connections200_response_spec.rb +0 -42
- data/spec/models/update_endpoints200_response_data_spec.rb +0 -36
- data/spec/models/update_endpoints200_response_spec.rb +0 -42
- data/spec/models/update_favorites200_response_data_spec.rb +0 -36
- data/spec/models/update_favorites200_response_spec.rb +0 -42
- data/spec/models/update_postgen_integrations200_response_data_spec.rb +0 -36
- data/spec/models/update_postgen_integrations200_response_spec.rb +0 -42
- data/spec/models/update_posts200_response_data_spec.rb +0 -36
- data/spec/models/update_posts200_response_spec.rb +0 -42
- data/spec/models/update_users200_response_data_spec.rb +0 -36
- data/spec/models/update_users200_response_spec.rb +0 -42
- data/spec/models/users_input_spec.rb +0 -76
- data/spec/models/users_spec.rb +0 -94
- data/spec/models/users_update_spec.rb +0 -76
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
|
+
| [**companies_company_id_users_user_id_favorites_category_category_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_category_category_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category |
|
|
8
|
+
| [**companies_company_id_users_user_id_favorites_check_asset_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_check_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states |
|
|
9
|
+
| [**companies_company_id_users_user_id_favorites_favorite_id_delete**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset) |
|
|
10
|
+
| [**companies_company_id_users_user_id_favorites_favorite_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID |
|
|
11
|
+
| [**companies_company_id_users_user_id_favorites_favorite_id_patch**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID Can update notes, category, priority |
|
|
12
|
+
| [**companies_company_id_users_user_id_favorites_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_get) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc) |
|
|
13
|
+
| [**companies_company_id_users_user_id_favorites_post**](FavoritesApi.md#companies_company_id_users_user_id_favorites_post) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites |
|
|
14
|
+
| [**companies_company_id_users_user_id_favorites_uncategorized_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_uncategorized_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category |
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## companies_company_id_users_user_id_favorites_category_category_get
|
|
18
18
|
|
|
19
|
-
>
|
|
19
|
+
> Object companies_company_id_users_user_id_favorites_category_category_get(company_id, user_id, category)
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Get all favorites for the specified user in a specific category
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -27,41 +27,39 @@ require 'time'
|
|
|
27
27
|
require 'spartera_api_sdk'
|
|
28
28
|
# setup authorization
|
|
29
29
|
SparteraApiSdk.configure do |config|
|
|
30
|
-
# Configure
|
|
31
|
-
config.
|
|
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'
|
|
30
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
34
32
|
end
|
|
35
33
|
|
|
36
34
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
37
|
-
company_id = 'company_id_example' # String |
|
|
38
|
-
user_id = 'user_id_example' # String |
|
|
39
|
-
|
|
35
|
+
company_id = 'company_id_example' # String |
|
|
36
|
+
user_id = 'user_id_example' # String |
|
|
37
|
+
category = 'category_example' # String |
|
|
40
38
|
|
|
41
39
|
begin
|
|
42
|
-
#
|
|
43
|
-
result = api_instance.
|
|
40
|
+
# Get all favorites for the specified user in a specific category
|
|
41
|
+
result = api_instance.companies_company_id_users_user_id_favorites_category_category_get(company_id, user_id, category)
|
|
44
42
|
p result
|
|
45
43
|
rescue SparteraApiSdk::ApiError => e
|
|
46
|
-
puts "Error when calling FavoritesApi->
|
|
44
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_category_category_get: #{e}"
|
|
47
45
|
end
|
|
48
46
|
```
|
|
49
47
|
|
|
50
|
-
#### Using the
|
|
48
|
+
#### Using the companies_company_id_users_user_id_favorites_category_category_get_with_http_info variant
|
|
51
49
|
|
|
52
50
|
This returns an Array which contains the response data, status code and headers.
|
|
53
51
|
|
|
54
|
-
> <Array(
|
|
52
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category)
|
|
55
53
|
|
|
56
54
|
```ruby
|
|
57
55
|
begin
|
|
58
|
-
#
|
|
59
|
-
data, status_code, headers = api_instance.
|
|
56
|
+
# Get all favorites for the specified user in a specific category
|
|
57
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_category_category_get_with_http_info(company_id, user_id, category)
|
|
60
58
|
p status_code # => 2xx
|
|
61
59
|
p headers # => { ... }
|
|
62
|
-
p data # =>
|
|
60
|
+
p data # => Object
|
|
63
61
|
rescue SparteraApiSdk::ApiError => e
|
|
64
|
-
puts "Error when calling FavoritesApi->
|
|
62
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_category_category_get_with_http_info: #{e}"
|
|
65
63
|
end
|
|
66
64
|
```
|
|
67
65
|
|
|
@@ -69,29 +67,29 @@ end
|
|
|
69
67
|
|
|
70
68
|
| Name | Type | Description | Notes |
|
|
71
69
|
| ---- | ---- | ----------- | ----- |
|
|
72
|
-
| **company_id** | **String** |
|
|
73
|
-
| **user_id** | **String** |
|
|
74
|
-
| **
|
|
70
|
+
| **company_id** | **String** | | |
|
|
71
|
+
| **user_id** | **String** | | |
|
|
72
|
+
| **category** | **String** | | |
|
|
75
73
|
|
|
76
74
|
### Return type
|
|
77
75
|
|
|
78
|
-
|
|
76
|
+
**Object**
|
|
79
77
|
|
|
80
78
|
### Authorization
|
|
81
79
|
|
|
82
|
-
[
|
|
80
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
83
81
|
|
|
84
82
|
### HTTP request headers
|
|
85
83
|
|
|
86
|
-
- **Content-Type**:
|
|
84
|
+
- **Content-Type**: Not defined
|
|
87
85
|
- **Accept**: application/json
|
|
88
86
|
|
|
89
87
|
|
|
90
|
-
##
|
|
88
|
+
## companies_company_id_users_user_id_favorites_check_asset_id_get
|
|
91
89
|
|
|
92
|
-
>
|
|
90
|
+
> Object companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
|
93
91
|
|
|
94
|
-
|
|
92
|
+
Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states
|
|
95
93
|
|
|
96
94
|
### Examples
|
|
97
95
|
|
|
@@ -100,41 +98,39 @@ require 'time'
|
|
|
100
98
|
require 'spartera_api_sdk'
|
|
101
99
|
# setup authorization
|
|
102
100
|
SparteraApiSdk.configure do |config|
|
|
103
|
-
# Configure
|
|
104
|
-
config.
|
|
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'
|
|
101
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
107
103
|
end
|
|
108
104
|
|
|
109
105
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
110
|
-
company_id = 'company_id_example' # String |
|
|
111
|
-
user_id = 'user_id_example' # String |
|
|
112
|
-
|
|
106
|
+
company_id = 'company_id_example' # String |
|
|
107
|
+
user_id = 'user_id_example' # String |
|
|
108
|
+
asset_id = 'asset_id_example' # String |
|
|
113
109
|
|
|
114
110
|
begin
|
|
115
|
-
#
|
|
116
|
-
result = api_instance.
|
|
111
|
+
# Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states
|
|
112
|
+
result = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
|
117
113
|
p result
|
|
118
114
|
rescue SparteraApiSdk::ApiError => e
|
|
119
|
-
puts "Error when calling FavoritesApi->
|
|
115
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_check_asset_id_get: #{e}"
|
|
120
116
|
end
|
|
121
117
|
```
|
|
122
118
|
|
|
123
|
-
#### Using the
|
|
119
|
+
#### Using the companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info variant
|
|
124
120
|
|
|
125
121
|
This returns an Array which contains the response data, status code and headers.
|
|
126
122
|
|
|
127
|
-
> <Array(
|
|
123
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
|
128
124
|
|
|
129
125
|
```ruby
|
|
130
126
|
begin
|
|
131
|
-
#
|
|
132
|
-
data, status_code, headers = api_instance.
|
|
127
|
+
# Check if the specified user has favorited a specific asset Returns the favorite record if it exists, or empty result if not Useful for UI to show/hide favorite button states
|
|
128
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
|
133
129
|
p status_code # => 2xx
|
|
134
130
|
p headers # => { ... }
|
|
135
|
-
p data # =>
|
|
131
|
+
p data # => Object
|
|
136
132
|
rescue SparteraApiSdk::ApiError => e
|
|
137
|
-
puts "Error when calling FavoritesApi->
|
|
133
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info: #{e}"
|
|
138
134
|
end
|
|
139
135
|
```
|
|
140
136
|
|
|
@@ -142,17 +138,17 @@ end
|
|
|
142
138
|
|
|
143
139
|
| Name | Type | Description | Notes |
|
|
144
140
|
| ---- | ---- | ----------- | ----- |
|
|
145
|
-
| **company_id** | **String** |
|
|
146
|
-
| **user_id** | **String** |
|
|
147
|
-
| **
|
|
141
|
+
| **company_id** | **String** | | |
|
|
142
|
+
| **user_id** | **String** | | |
|
|
143
|
+
| **asset_id** | **String** | | |
|
|
148
144
|
|
|
149
145
|
### Return type
|
|
150
146
|
|
|
151
|
-
|
|
147
|
+
**Object**
|
|
152
148
|
|
|
153
149
|
### Authorization
|
|
154
150
|
|
|
155
|
-
[
|
|
151
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
156
152
|
|
|
157
153
|
### HTTP request headers
|
|
158
154
|
|
|
@@ -160,11 +156,11 @@ end
|
|
|
160
156
|
- **Accept**: application/json
|
|
161
157
|
|
|
162
158
|
|
|
163
|
-
##
|
|
159
|
+
## companies_company_id_users_user_id_favorites_favorite_id_delete
|
|
164
160
|
|
|
165
|
-
>
|
|
161
|
+
> Object companies_company_id_users_user_id_favorites_favorite_id_delete(company_id, user_id, favorite_id)
|
|
166
162
|
|
|
167
|
-
|
|
163
|
+
Delete single favorite by ID (unfavorite an asset)
|
|
168
164
|
|
|
169
165
|
### Examples
|
|
170
166
|
|
|
@@ -173,40 +169,39 @@ require 'time'
|
|
|
173
169
|
require 'spartera_api_sdk'
|
|
174
170
|
# setup authorization
|
|
175
171
|
SparteraApiSdk.configure do |config|
|
|
176
|
-
# Configure
|
|
177
|
-
config.
|
|
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'
|
|
172
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
173
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
180
174
|
end
|
|
181
175
|
|
|
182
176
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
183
|
-
company_id = 'company_id_example' # String |
|
|
184
|
-
user_id = 'user_id_example' # String |
|
|
177
|
+
company_id = 'company_id_example' # String |
|
|
178
|
+
user_id = 'user_id_example' # String |
|
|
179
|
+
favorite_id = 'favorite_id_example' # String |
|
|
185
180
|
|
|
186
181
|
begin
|
|
187
|
-
#
|
|
188
|
-
result = api_instance.
|
|
182
|
+
# Delete single favorite by ID (unfavorite an asset)
|
|
183
|
+
result = api_instance.companies_company_id_users_user_id_favorites_favorite_id_delete(company_id, user_id, favorite_id)
|
|
189
184
|
p result
|
|
190
185
|
rescue SparteraApiSdk::ApiError => e
|
|
191
|
-
puts "Error when calling FavoritesApi->
|
|
186
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_delete: #{e}"
|
|
192
187
|
end
|
|
193
188
|
```
|
|
194
189
|
|
|
195
|
-
#### Using the
|
|
190
|
+
#### Using the companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info variant
|
|
196
191
|
|
|
197
192
|
This returns an Array which contains the response data, status code and headers.
|
|
198
193
|
|
|
199
|
-
> <Array(
|
|
194
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id)
|
|
200
195
|
|
|
201
196
|
```ruby
|
|
202
197
|
begin
|
|
203
|
-
#
|
|
204
|
-
data, status_code, headers = api_instance.
|
|
198
|
+
# Delete single favorite by ID (unfavorite an asset)
|
|
199
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info(company_id, user_id, favorite_id)
|
|
205
200
|
p status_code # => 2xx
|
|
206
201
|
p headers # => { ... }
|
|
207
|
-
p data # =>
|
|
202
|
+
p data # => Object
|
|
208
203
|
rescue SparteraApiSdk::ApiError => e
|
|
209
|
-
puts "Error when calling FavoritesApi->
|
|
204
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_delete_with_http_info: #{e}"
|
|
210
205
|
end
|
|
211
206
|
```
|
|
212
207
|
|
|
@@ -214,16 +209,17 @@ end
|
|
|
214
209
|
|
|
215
210
|
| Name | Type | Description | Notes |
|
|
216
211
|
| ---- | ---- | ----------- | ----- |
|
|
217
|
-
| **company_id** | **String** |
|
|
218
|
-
| **user_id** | **String** |
|
|
212
|
+
| **company_id** | **String** | | |
|
|
213
|
+
| **user_id** | **String** | | |
|
|
214
|
+
| **favorite_id** | **String** | | |
|
|
219
215
|
|
|
220
216
|
### Return type
|
|
221
217
|
|
|
222
|
-
|
|
218
|
+
**Object**
|
|
223
219
|
|
|
224
220
|
### Authorization
|
|
225
221
|
|
|
226
|
-
[
|
|
222
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
227
223
|
|
|
228
224
|
### HTTP request headers
|
|
229
225
|
|
|
@@ -231,9 +227,9 @@ end
|
|
|
231
227
|
- **Accept**: application/json
|
|
232
228
|
|
|
233
229
|
|
|
234
|
-
##
|
|
230
|
+
## companies_company_id_users_user_id_favorites_favorite_id_get
|
|
235
231
|
|
|
236
|
-
>
|
|
232
|
+
> Object companies_company_id_users_user_id_favorites_favorite_id_get(company_id, user_id, favorite_id)
|
|
237
233
|
|
|
238
234
|
Get single favorite by ID
|
|
239
235
|
|
|
@@ -244,41 +240,39 @@ require 'time'
|
|
|
244
240
|
require 'spartera_api_sdk'
|
|
245
241
|
# setup authorization
|
|
246
242
|
SparteraApiSdk.configure do |config|
|
|
247
|
-
# Configure
|
|
248
|
-
config.
|
|
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'
|
|
243
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
244
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
251
245
|
end
|
|
252
246
|
|
|
253
247
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
254
|
-
company_id = 'company_id_example' # String |
|
|
255
|
-
user_id = 'user_id_example' # String |
|
|
256
|
-
favorite_id = 'favorite_id_example' # String |
|
|
248
|
+
company_id = 'company_id_example' # String |
|
|
249
|
+
user_id = 'user_id_example' # String |
|
|
250
|
+
favorite_id = 'favorite_id_example' # String |
|
|
257
251
|
|
|
258
252
|
begin
|
|
259
253
|
# Get single favorite by ID
|
|
260
|
-
result = api_instance.
|
|
254
|
+
result = api_instance.companies_company_id_users_user_id_favorites_favorite_id_get(company_id, user_id, favorite_id)
|
|
261
255
|
p result
|
|
262
256
|
rescue SparteraApiSdk::ApiError => e
|
|
263
|
-
puts "Error when calling FavoritesApi->
|
|
257
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_get: #{e}"
|
|
264
258
|
end
|
|
265
259
|
```
|
|
266
260
|
|
|
267
|
-
#### Using the
|
|
261
|
+
#### Using the companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info variant
|
|
268
262
|
|
|
269
263
|
This returns an Array which contains the response data, status code and headers.
|
|
270
264
|
|
|
271
|
-
> <Array(
|
|
265
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id)
|
|
272
266
|
|
|
273
267
|
```ruby
|
|
274
268
|
begin
|
|
275
269
|
# Get single favorite by ID
|
|
276
|
-
data, status_code, headers = api_instance.
|
|
270
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info(company_id, user_id, favorite_id)
|
|
277
271
|
p status_code # => 2xx
|
|
278
272
|
p headers # => { ... }
|
|
279
|
-
p data # =>
|
|
273
|
+
p data # => Object
|
|
280
274
|
rescue SparteraApiSdk::ApiError => e
|
|
281
|
-
puts "Error when calling FavoritesApi->
|
|
275
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_get_with_http_info: #{e}"
|
|
282
276
|
end
|
|
283
277
|
```
|
|
284
278
|
|
|
@@ -286,17 +280,17 @@ end
|
|
|
286
280
|
|
|
287
281
|
| Name | Type | Description | Notes |
|
|
288
282
|
| ---- | ---- | ----------- | ----- |
|
|
289
|
-
| **company_id** | **String** |
|
|
290
|
-
| **user_id** | **String** |
|
|
291
|
-
| **favorite_id** | **String** |
|
|
283
|
+
| **company_id** | **String** | | |
|
|
284
|
+
| **user_id** | **String** | | |
|
|
285
|
+
| **favorite_id** | **String** | | |
|
|
292
286
|
|
|
293
287
|
### Return type
|
|
294
288
|
|
|
295
|
-
|
|
289
|
+
**Object**
|
|
296
290
|
|
|
297
291
|
### Authorization
|
|
298
292
|
|
|
299
|
-
[
|
|
293
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
300
294
|
|
|
301
295
|
### HTTP request headers
|
|
302
296
|
|
|
@@ -304,11 +298,11 @@ end
|
|
|
304
298
|
- **Accept**: application/json
|
|
305
299
|
|
|
306
300
|
|
|
307
|
-
##
|
|
301
|
+
## companies_company_id_users_user_id_favorites_favorite_id_patch
|
|
308
302
|
|
|
309
|
-
>
|
|
303
|
+
> Object companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
|
310
304
|
|
|
311
|
-
|
|
305
|
+
Update an existing favorite by ID Can update notes, category, priority
|
|
312
306
|
|
|
313
307
|
### Examples
|
|
314
308
|
|
|
@@ -317,41 +311,40 @@ require 'time'
|
|
|
317
311
|
require 'spartera_api_sdk'
|
|
318
312
|
# setup authorization
|
|
319
313
|
SparteraApiSdk.configure do |config|
|
|
320
|
-
# Configure
|
|
321
|
-
config.
|
|
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'
|
|
314
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
315
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
324
316
|
end
|
|
325
317
|
|
|
326
318
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
327
|
-
company_id = 'company_id_example' # String |
|
|
328
|
-
user_id = 'user_id_example' # String |
|
|
329
|
-
|
|
319
|
+
company_id = 'company_id_example' # String |
|
|
320
|
+
user_id = 'user_id_example' # String |
|
|
321
|
+
favorite_id = 'favorite_id_example' # String |
|
|
322
|
+
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
|
330
323
|
|
|
331
324
|
begin
|
|
332
|
-
#
|
|
333
|
-
result = api_instance.
|
|
325
|
+
# Update an existing favorite by ID Can update notes, category, priority
|
|
326
|
+
result = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
|
334
327
|
p result
|
|
335
328
|
rescue SparteraApiSdk::ApiError => e
|
|
336
|
-
puts "Error when calling FavoritesApi->
|
|
329
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_patch: #{e}"
|
|
337
330
|
end
|
|
338
331
|
```
|
|
339
332
|
|
|
340
|
-
#### Using the
|
|
333
|
+
#### Using the companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info variant
|
|
341
334
|
|
|
342
335
|
This returns an Array which contains the response data, status code and headers.
|
|
343
336
|
|
|
344
|
-
> <Array(
|
|
337
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite)
|
|
345
338
|
|
|
346
339
|
```ruby
|
|
347
340
|
begin
|
|
348
|
-
#
|
|
349
|
-
data, status_code, headers = api_instance.
|
|
341
|
+
# Update an existing favorite by ID Can update notes, category, priority
|
|
342
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite)
|
|
350
343
|
p status_code # => 2xx
|
|
351
344
|
p headers # => { ... }
|
|
352
|
-
p data # =>
|
|
345
|
+
p data # => Object
|
|
353
346
|
rescue SparteraApiSdk::ApiError => e
|
|
354
|
-
puts "Error when calling FavoritesApi->
|
|
347
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info: #{e}"
|
|
355
348
|
end
|
|
356
349
|
```
|
|
357
350
|
|
|
@@ -359,29 +352,30 @@ end
|
|
|
359
352
|
|
|
360
353
|
| Name | Type | Description | Notes |
|
|
361
354
|
| ---- | ---- | ----------- | ----- |
|
|
362
|
-
| **company_id** | **String** |
|
|
363
|
-
| **user_id** | **String** |
|
|
364
|
-
| **
|
|
355
|
+
| **company_id** | **String** | | |
|
|
356
|
+
| **user_id** | **String** | | |
|
|
357
|
+
| **favorite_id** | **String** | | |
|
|
358
|
+
| **favorite** | [**Favorite**](Favorite.md) | | |
|
|
365
359
|
|
|
366
360
|
### Return type
|
|
367
361
|
|
|
368
|
-
|
|
362
|
+
**Object**
|
|
369
363
|
|
|
370
364
|
### Authorization
|
|
371
365
|
|
|
372
|
-
[
|
|
366
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
373
367
|
|
|
374
368
|
### HTTP request headers
|
|
375
369
|
|
|
376
|
-
- **Content-Type**:
|
|
370
|
+
- **Content-Type**: application/json
|
|
377
371
|
- **Accept**: application/json
|
|
378
372
|
|
|
379
373
|
|
|
380
|
-
##
|
|
374
|
+
## companies_company_id_users_user_id_favorites_get
|
|
381
375
|
|
|
382
|
-
>
|
|
376
|
+
> Object companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
|
383
377
|
|
|
384
|
-
|
|
378
|
+
Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc)
|
|
385
379
|
|
|
386
380
|
### Examples
|
|
387
381
|
|
|
@@ -390,41 +384,38 @@ require 'time'
|
|
|
390
384
|
require 'spartera_api_sdk'
|
|
391
385
|
# setup authorization
|
|
392
386
|
SparteraApiSdk.configure do |config|
|
|
393
|
-
# Configure
|
|
394
|
-
config.
|
|
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'
|
|
387
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
388
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
397
389
|
end
|
|
398
390
|
|
|
399
391
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
400
|
-
company_id = 'company_id_example' # String |
|
|
401
|
-
user_id = 'user_id_example' # String |
|
|
402
|
-
asset_id = 'asset_id_example' # String | Unique identifier for the Asset
|
|
392
|
+
company_id = 'company_id_example' # String |
|
|
393
|
+
user_id = 'user_id_example' # String |
|
|
403
394
|
|
|
404
395
|
begin
|
|
405
|
-
#
|
|
406
|
-
result = api_instance.
|
|
396
|
+
# Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc)
|
|
397
|
+
result = api_instance.companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
|
407
398
|
p result
|
|
408
399
|
rescue SparteraApiSdk::ApiError => e
|
|
409
|
-
puts "Error when calling FavoritesApi->
|
|
400
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_get: #{e}"
|
|
410
401
|
end
|
|
411
402
|
```
|
|
412
403
|
|
|
413
|
-
#### Using the
|
|
404
|
+
#### Using the companies_company_id_users_user_id_favorites_get_with_http_info variant
|
|
414
405
|
|
|
415
406
|
This returns an Array which contains the response data, status code and headers.
|
|
416
407
|
|
|
417
|
-
> <Array(
|
|
408
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id)
|
|
418
409
|
|
|
419
410
|
```ruby
|
|
420
411
|
begin
|
|
421
|
-
#
|
|
422
|
-
data, status_code, headers = api_instance.
|
|
412
|
+
# Get a list of all favorites for a specific user Query params: - category: filter by category - sort: sort field (priority, date_created, etc.) - order: sort direction (asc, desc)
|
|
413
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id)
|
|
423
414
|
p status_code # => 2xx
|
|
424
415
|
p headers # => { ... }
|
|
425
|
-
p data # =>
|
|
416
|
+
p data # => Object
|
|
426
417
|
rescue SparteraApiSdk::ApiError => e
|
|
427
|
-
puts "Error when calling FavoritesApi->
|
|
418
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_get_with_http_info: #{e}"
|
|
428
419
|
end
|
|
429
420
|
```
|
|
430
421
|
|
|
@@ -432,17 +423,16 @@ end
|
|
|
432
423
|
|
|
433
424
|
| Name | Type | Description | Notes |
|
|
434
425
|
| ---- | ---- | ----------- | ----- |
|
|
435
|
-
| **company_id** | **String** |
|
|
436
|
-
| **user_id** | **String** |
|
|
437
|
-
| **asset_id** | **String** | Unique identifier for the Asset | |
|
|
426
|
+
| **company_id** | **String** | | |
|
|
427
|
+
| **user_id** | **String** | | |
|
|
438
428
|
|
|
439
429
|
### Return type
|
|
440
430
|
|
|
441
|
-
|
|
431
|
+
**Object**
|
|
442
432
|
|
|
443
433
|
### Authorization
|
|
444
434
|
|
|
445
|
-
[
|
|
435
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
446
436
|
|
|
447
437
|
### HTTP request headers
|
|
448
438
|
|
|
@@ -450,11 +440,11 @@ end
|
|
|
450
440
|
- **Accept**: application/json
|
|
451
441
|
|
|
452
442
|
|
|
453
|
-
##
|
|
443
|
+
## companies_company_id_users_user_id_favorites_post
|
|
454
444
|
|
|
455
|
-
>
|
|
445
|
+
> Object companies_company_id_users_user_id_favorites_post(company_id, user_id, favorite)
|
|
456
446
|
|
|
457
|
-
|
|
447
|
+
POST /companies/{company_id}/users/{user_id}/favorites
|
|
458
448
|
|
|
459
449
|
### Examples
|
|
460
450
|
|
|
@@ -463,40 +453,39 @@ require 'time'
|
|
|
463
453
|
require 'spartera_api_sdk'
|
|
464
454
|
# setup authorization
|
|
465
455
|
SparteraApiSdk.configure do |config|
|
|
466
|
-
# Configure
|
|
467
|
-
config.
|
|
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'
|
|
456
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
457
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
470
458
|
end
|
|
471
459
|
|
|
472
460
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
473
|
-
company_id = 'company_id_example' # String |
|
|
474
|
-
user_id = 'user_id_example' # String |
|
|
461
|
+
company_id = 'company_id_example' # String |
|
|
462
|
+
user_id = 'user_id_example' # String |
|
|
463
|
+
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
|
475
464
|
|
|
476
465
|
begin
|
|
477
|
-
#
|
|
478
|
-
result = api_instance.
|
|
466
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
|
467
|
+
result = api_instance.companies_company_id_users_user_id_favorites_post(company_id, user_id, favorite)
|
|
479
468
|
p result
|
|
480
469
|
rescue SparteraApiSdk::ApiError => e
|
|
481
|
-
puts "Error when calling FavoritesApi->
|
|
470
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_post: #{e}"
|
|
482
471
|
end
|
|
483
472
|
```
|
|
484
473
|
|
|
485
|
-
#### Using the
|
|
474
|
+
#### Using the companies_company_id_users_user_id_favorites_post_with_http_info variant
|
|
486
475
|
|
|
487
476
|
This returns an Array which contains the response data, status code and headers.
|
|
488
477
|
|
|
489
|
-
> <Array(
|
|
478
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite)
|
|
490
479
|
|
|
491
480
|
```ruby
|
|
492
481
|
begin
|
|
493
|
-
#
|
|
494
|
-
data, status_code, headers = api_instance.
|
|
482
|
+
# POST /companies/{company_id}/users/{user_id}/favorites
|
|
483
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_post_with_http_info(company_id, user_id, favorite)
|
|
495
484
|
p status_code # => 2xx
|
|
496
485
|
p headers # => { ... }
|
|
497
|
-
p data # =>
|
|
486
|
+
p data # => Object
|
|
498
487
|
rescue SparteraApiSdk::ApiError => e
|
|
499
|
-
puts "Error when calling FavoritesApi->
|
|
488
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_post_with_http_info: #{e}"
|
|
500
489
|
end
|
|
501
490
|
```
|
|
502
491
|
|
|
@@ -504,28 +493,29 @@ end
|
|
|
504
493
|
|
|
505
494
|
| Name | Type | Description | Notes |
|
|
506
495
|
| ---- | ---- | ----------- | ----- |
|
|
507
|
-
| **company_id** | **String** |
|
|
508
|
-
| **user_id** | **String** |
|
|
496
|
+
| **company_id** | **String** | | |
|
|
497
|
+
| **user_id** | **String** | | |
|
|
498
|
+
| **favorite** | [**Favorite**](Favorite.md) | | |
|
|
509
499
|
|
|
510
500
|
### Return type
|
|
511
501
|
|
|
512
|
-
|
|
502
|
+
**Object**
|
|
513
503
|
|
|
514
504
|
### Authorization
|
|
515
505
|
|
|
516
|
-
[
|
|
506
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
517
507
|
|
|
518
508
|
### HTTP request headers
|
|
519
509
|
|
|
520
|
-
- **Content-Type**:
|
|
510
|
+
- **Content-Type**: application/json
|
|
521
511
|
- **Accept**: application/json
|
|
522
512
|
|
|
523
513
|
|
|
524
|
-
##
|
|
514
|
+
## companies_company_id_users_user_id_favorites_uncategorized_get
|
|
525
515
|
|
|
526
|
-
>
|
|
516
|
+
> Object companies_company_id_users_user_id_favorites_uncategorized_get(company_id, user_id)
|
|
527
517
|
|
|
528
|
-
|
|
518
|
+
Get all favorites for the specified user that don't have a category
|
|
529
519
|
|
|
530
520
|
### Examples
|
|
531
521
|
|
|
@@ -534,42 +524,38 @@ require 'time'
|
|
|
534
524
|
require 'spartera_api_sdk'
|
|
535
525
|
# setup authorization
|
|
536
526
|
SparteraApiSdk.configure do |config|
|
|
537
|
-
# Configure
|
|
538
|
-
config.
|
|
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'
|
|
527
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
528
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
541
529
|
end
|
|
542
530
|
|
|
543
531
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
|
544
|
-
company_id = 'company_id_example' # String |
|
|
545
|
-
user_id = 'user_id_example' # String |
|
|
546
|
-
favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
|
|
547
|
-
favorites_update = SparteraApiSdk::FavoritesUpdate.new # FavoritesUpdate |
|
|
532
|
+
company_id = 'company_id_example' # String |
|
|
533
|
+
user_id = 'user_id_example' # String |
|
|
548
534
|
|
|
549
535
|
begin
|
|
550
|
-
#
|
|
551
|
-
result = api_instance.
|
|
536
|
+
# Get all favorites for the specified user that don't have a category
|
|
537
|
+
result = api_instance.companies_company_id_users_user_id_favorites_uncategorized_get(company_id, user_id)
|
|
552
538
|
p result
|
|
553
539
|
rescue SparteraApiSdk::ApiError => e
|
|
554
|
-
puts "Error when calling FavoritesApi->
|
|
540
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_uncategorized_get: #{e}"
|
|
555
541
|
end
|
|
556
542
|
```
|
|
557
543
|
|
|
558
|
-
#### Using the
|
|
544
|
+
#### Using the companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info variant
|
|
559
545
|
|
|
560
546
|
This returns an Array which contains the response data, status code and headers.
|
|
561
547
|
|
|
562
|
-
> <Array(
|
|
548
|
+
> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id)
|
|
563
549
|
|
|
564
550
|
```ruby
|
|
565
551
|
begin
|
|
566
|
-
#
|
|
567
|
-
data, status_code, headers = api_instance.
|
|
552
|
+
# Get all favorites for the specified user that don't have a category
|
|
553
|
+
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info(company_id, user_id)
|
|
568
554
|
p status_code # => 2xx
|
|
569
555
|
p headers # => { ... }
|
|
570
|
-
p data # =>
|
|
556
|
+
p data # => Object
|
|
571
557
|
rescue SparteraApiSdk::ApiError => e
|
|
572
|
-
puts "Error when calling FavoritesApi->
|
|
558
|
+
puts "Error when calling FavoritesApi->companies_company_id_users_user_id_favorites_uncategorized_get_with_http_info: #{e}"
|
|
573
559
|
end
|
|
574
560
|
```
|
|
575
561
|
|
|
@@ -577,21 +563,19 @@ end
|
|
|
577
563
|
|
|
578
564
|
| Name | Type | Description | Notes |
|
|
579
565
|
| ---- | ---- | ----------- | ----- |
|
|
580
|
-
| **company_id** | **String** |
|
|
581
|
-
| **user_id** | **String** |
|
|
582
|
-
| **favorite_id** | **String** | Unique identifier for the Favorite | |
|
|
583
|
-
| **favorites_update** | [**FavoritesUpdate**](FavoritesUpdate.md) | | |
|
|
566
|
+
| **company_id** | **String** | | |
|
|
567
|
+
| **user_id** | **String** | | |
|
|
584
568
|
|
|
585
569
|
### Return type
|
|
586
570
|
|
|
587
|
-
|
|
571
|
+
**Object**
|
|
588
572
|
|
|
589
573
|
### Authorization
|
|
590
574
|
|
|
591
|
-
[
|
|
575
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
592
576
|
|
|
593
577
|
### HTTP request headers
|
|
594
578
|
|
|
595
|
-
- **Content-Type**:
|
|
579
|
+
- **Content-Type**: Not defined
|
|
596
580
|
- **Accept**: application/json
|
|
597
581
|
|