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/CompaniesApi.md
CHANGED
|
@@ -4,22 +4,23 @@ 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
|
-
| [**
|
|
15
|
-
| [**
|
|
7
|
+
| [**get_companies_by_id**](CompaniesApi.md#get_companies_by_id) | **GET** /companies/{company_id} | Get details of the requestor's own company |
|
|
8
|
+
| [**list_companies**](CompaniesApi.md#list_companies) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company's current subscription plan. |
|
|
9
|
+
| [**list_companies_analytics_assets**](CompaniesApi.md#list_companies_analytics_assets) | **GET** /companies/{company_id}/analytics/assets | Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include |
|
|
10
|
+
| [**list_companies_analytics_customers**](CompaniesApi.md#list_companies_analytics_customers) | **GET** /companies/{company_id}/analytics/customers | Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by |
|
|
11
|
+
| [**list_companies_analytics_dashboard**](CompaniesApi.md#list_companies_analytics_dashboard) | **GET** /companies/{company_id}/analytics/dashboard | Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter) |
|
|
12
|
+
| [**list_companies_analytics_metrics**](CompaniesApi.md#list_companies_analytics_metrics) | **GET** /companies/{company_id}/analytics/metrics | Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s |
|
|
13
|
+
| [**list_companies_analytics_sales**](CompaniesApi.md#list_companies_analytics_sales) | **GET** /companies/{company_id}/analytics/sales | Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics |
|
|
14
|
+
| [**list_companies_objects**](CompaniesApi.md#list_companies_objects) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company |
|
|
15
|
+
| [**list_companies_requests_usage**](CompaniesApi.md#list_companies_requests_usage) | **GET** /companies/{company_id}/requests/usage | Get company request usage data for a specific month. |
|
|
16
|
+
| [**update_companies**](CompaniesApi.md#update_companies) | **PATCH** /companies/{company_id} | Update an existing company by ID |
|
|
16
17
|
|
|
17
18
|
|
|
18
|
-
##
|
|
19
|
+
## get_companies_by_id
|
|
19
20
|
|
|
20
|
-
> <
|
|
21
|
+
> <GetCompaniesById200Response> get_companies_by_id(company_id)
|
|
21
22
|
|
|
22
|
-
Get
|
|
23
|
+
Get details of the requestor's own company
|
|
23
24
|
|
|
24
25
|
### Examples
|
|
25
26
|
|
|
@@ -35,32 +36,32 @@ SparteraApiSdk.configure do |config|
|
|
|
35
36
|
end
|
|
36
37
|
|
|
37
38
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
38
|
-
company_id = 'company_id_example' # String |
|
|
39
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
39
40
|
|
|
40
41
|
begin
|
|
41
|
-
# Get
|
|
42
|
-
result = api_instance.
|
|
42
|
+
# Get details of the requestor's own company
|
|
43
|
+
result = api_instance.get_companies_by_id(company_id)
|
|
43
44
|
p result
|
|
44
45
|
rescue SparteraApiSdk::ApiError => e
|
|
45
|
-
puts "Error when calling CompaniesApi->
|
|
46
|
+
puts "Error when calling CompaniesApi->get_companies_by_id: #{e}"
|
|
46
47
|
end
|
|
47
48
|
```
|
|
48
49
|
|
|
49
|
-
#### Using the
|
|
50
|
+
#### Using the get_companies_by_id_with_http_info variant
|
|
50
51
|
|
|
51
52
|
This returns an Array which contains the response data, status code and headers.
|
|
52
53
|
|
|
53
|
-
> <Array(<
|
|
54
|
+
> <Array(<GetCompaniesById200Response>, Integer, Hash)> get_companies_by_id_with_http_info(company_id)
|
|
54
55
|
|
|
55
56
|
```ruby
|
|
56
57
|
begin
|
|
57
|
-
# Get
|
|
58
|
-
data, status_code, headers = api_instance.
|
|
58
|
+
# Get details of the requestor's own company
|
|
59
|
+
data, status_code, headers = api_instance.get_companies_by_id_with_http_info(company_id)
|
|
59
60
|
p status_code # => 2xx
|
|
60
61
|
p headers # => { ... }
|
|
61
|
-
p data # => <
|
|
62
|
+
p data # => <GetCompaniesById200Response>
|
|
62
63
|
rescue SparteraApiSdk::ApiError => e
|
|
63
|
-
puts "Error when calling CompaniesApi->
|
|
64
|
+
puts "Error when calling CompaniesApi->get_companies_by_id_with_http_info: #{e}"
|
|
64
65
|
end
|
|
65
66
|
```
|
|
66
67
|
|
|
@@ -68,11 +69,11 @@ end
|
|
|
68
69
|
|
|
69
70
|
| Name | Type | Description | Notes |
|
|
70
71
|
| ---- | ---- | ----------- | ----- |
|
|
71
|
-
| **company_id** | **String** |
|
|
72
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
72
73
|
|
|
73
74
|
### Return type
|
|
74
75
|
|
|
75
|
-
[**
|
|
76
|
+
[**GetCompaniesById200Response**](GetCompaniesById200Response.md)
|
|
76
77
|
|
|
77
78
|
### Authorization
|
|
78
79
|
|
|
@@ -84,11 +85,11 @@ end
|
|
|
84
85
|
- **Accept**: application/json
|
|
85
86
|
|
|
86
87
|
|
|
87
|
-
##
|
|
88
|
+
## list_companies
|
|
88
89
|
|
|
89
|
-
> <
|
|
90
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies(company_id, opts)
|
|
90
91
|
|
|
91
|
-
Get
|
|
92
|
+
Get the total number of requests allocated in the company's current subscription plan.
|
|
92
93
|
|
|
93
94
|
### Examples
|
|
94
95
|
|
|
@@ -104,32 +105,39 @@ SparteraApiSdk.configure do |config|
|
|
|
104
105
|
end
|
|
105
106
|
|
|
106
107
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
107
|
-
company_id = 'company_id_example' # String |
|
|
108
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
109
|
+
opts = {
|
|
110
|
+
page: 56, # Integer | Page number for pagination
|
|
111
|
+
limit: 56, # Integer | Number of items per page
|
|
112
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
113
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
114
|
+
search: 'search_example' # String | Search term to filter results
|
|
115
|
+
}
|
|
108
116
|
|
|
109
117
|
begin
|
|
110
|
-
# Get
|
|
111
|
-
result = api_instance.
|
|
118
|
+
# Get the total number of requests allocated in the company's current subscription plan.
|
|
119
|
+
result = api_instance.list_companies(company_id, opts)
|
|
112
120
|
p result
|
|
113
121
|
rescue SparteraApiSdk::ApiError => e
|
|
114
|
-
puts "Error when calling CompaniesApi->
|
|
122
|
+
puts "Error when calling CompaniesApi->list_companies: #{e}"
|
|
115
123
|
end
|
|
116
124
|
```
|
|
117
125
|
|
|
118
|
-
#### Using the
|
|
126
|
+
#### Using the list_companies_with_http_info variant
|
|
119
127
|
|
|
120
128
|
This returns an Array which contains the response data, status code and headers.
|
|
121
129
|
|
|
122
|
-
> <Array(<
|
|
130
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_with_http_info(company_id, opts)
|
|
123
131
|
|
|
124
132
|
```ruby
|
|
125
133
|
begin
|
|
126
|
-
# Get
|
|
127
|
-
data, status_code, headers = api_instance.
|
|
134
|
+
# Get the total number of requests allocated in the company's current subscription plan.
|
|
135
|
+
data, status_code, headers = api_instance.list_companies_with_http_info(company_id, opts)
|
|
128
136
|
p status_code # => 2xx
|
|
129
137
|
p headers # => { ... }
|
|
130
|
-
p data # => <
|
|
138
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
131
139
|
rescue SparteraApiSdk::ApiError => e
|
|
132
|
-
puts "Error when calling CompaniesApi->
|
|
140
|
+
puts "Error when calling CompaniesApi->list_companies_with_http_info: #{e}"
|
|
133
141
|
end
|
|
134
142
|
```
|
|
135
143
|
|
|
@@ -137,11 +145,16 @@ end
|
|
|
137
145
|
|
|
138
146
|
| Name | Type | Description | Notes |
|
|
139
147
|
| ---- | ---- | ----------- | ----- |
|
|
140
|
-
| **company_id** | **String** |
|
|
148
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
149
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
150
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
151
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
152
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
153
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
141
154
|
|
|
142
155
|
### Return type
|
|
143
156
|
|
|
144
|
-
[**
|
|
157
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
145
158
|
|
|
146
159
|
### Authorization
|
|
147
160
|
|
|
@@ -153,11 +166,11 @@ end
|
|
|
153
166
|
- **Accept**: application/json
|
|
154
167
|
|
|
155
168
|
|
|
156
|
-
##
|
|
169
|
+
## list_companies_analytics_assets
|
|
157
170
|
|
|
158
|
-
> <
|
|
171
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_analytics_assets(company_id, opts)
|
|
159
172
|
|
|
160
|
-
Get
|
|
173
|
+
Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
|
|
161
174
|
|
|
162
175
|
### Examples
|
|
163
176
|
|
|
@@ -173,32 +186,39 @@ SparteraApiSdk.configure do |config|
|
|
|
173
186
|
end
|
|
174
187
|
|
|
175
188
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
176
|
-
company_id = 'company_id_example' # String |
|
|
189
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
190
|
+
opts = {
|
|
191
|
+
page: 56, # Integer | Page number for pagination
|
|
192
|
+
limit: 56, # Integer | Number of items per page
|
|
193
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
194
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
195
|
+
search: 'search_example' # String | Search term to filter results
|
|
196
|
+
}
|
|
177
197
|
|
|
178
198
|
begin
|
|
179
|
-
# Get
|
|
180
|
-
result = api_instance.
|
|
199
|
+
# Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
|
|
200
|
+
result = api_instance.list_companies_analytics_assets(company_id, opts)
|
|
181
201
|
p result
|
|
182
202
|
rescue SparteraApiSdk::ApiError => e
|
|
183
|
-
puts "Error when calling CompaniesApi->
|
|
203
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_assets: #{e}"
|
|
184
204
|
end
|
|
185
205
|
```
|
|
186
206
|
|
|
187
|
-
#### Using the
|
|
207
|
+
#### Using the list_companies_analytics_assets_with_http_info variant
|
|
188
208
|
|
|
189
209
|
This returns an Array which contains the response data, status code and headers.
|
|
190
210
|
|
|
191
|
-
> <Array(<
|
|
211
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_analytics_assets_with_http_info(company_id, opts)
|
|
192
212
|
|
|
193
213
|
```ruby
|
|
194
214
|
begin
|
|
195
|
-
# Get
|
|
196
|
-
data, status_code, headers = api_instance.
|
|
215
|
+
# Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
|
|
216
|
+
data, status_code, headers = api_instance.list_companies_analytics_assets_with_http_info(company_id, opts)
|
|
197
217
|
p status_code # => 2xx
|
|
198
218
|
p headers # => { ... }
|
|
199
|
-
p data # => <
|
|
219
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
200
220
|
rescue SparteraApiSdk::ApiError => e
|
|
201
|
-
puts "Error when calling CompaniesApi->
|
|
221
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_assets_with_http_info: #{e}"
|
|
202
222
|
end
|
|
203
223
|
```
|
|
204
224
|
|
|
@@ -206,11 +226,16 @@ end
|
|
|
206
226
|
|
|
207
227
|
| Name | Type | Description | Notes |
|
|
208
228
|
| ---- | ---- | ----------- | ----- |
|
|
209
|
-
| **company_id** | **String** |
|
|
229
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
230
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
231
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
232
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
233
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
234
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
210
235
|
|
|
211
236
|
### Return type
|
|
212
237
|
|
|
213
|
-
[**
|
|
238
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
214
239
|
|
|
215
240
|
### Authorization
|
|
216
241
|
|
|
@@ -222,11 +247,11 @@ end
|
|
|
222
247
|
- **Accept**: application/json
|
|
223
248
|
|
|
224
249
|
|
|
225
|
-
##
|
|
250
|
+
## list_companies_analytics_customers
|
|
226
251
|
|
|
227
|
-
> <
|
|
252
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_analytics_customers(company_id, opts)
|
|
228
253
|
|
|
229
|
-
Get
|
|
254
|
+
Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
|
|
230
255
|
|
|
231
256
|
### Examples
|
|
232
257
|
|
|
@@ -242,32 +267,39 @@ SparteraApiSdk.configure do |config|
|
|
|
242
267
|
end
|
|
243
268
|
|
|
244
269
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
245
|
-
company_id = 'company_id_example' # String |
|
|
270
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
271
|
+
opts = {
|
|
272
|
+
page: 56, # Integer | Page number for pagination
|
|
273
|
+
limit: 56, # Integer | Number of items per page
|
|
274
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
275
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
276
|
+
search: 'search_example' # String | Search term to filter results
|
|
277
|
+
}
|
|
246
278
|
|
|
247
279
|
begin
|
|
248
|
-
# Get
|
|
249
|
-
result = api_instance.
|
|
280
|
+
# Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
|
|
281
|
+
result = api_instance.list_companies_analytics_customers(company_id, opts)
|
|
250
282
|
p result
|
|
251
283
|
rescue SparteraApiSdk::ApiError => e
|
|
252
|
-
puts "Error when calling CompaniesApi->
|
|
284
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_customers: #{e}"
|
|
253
285
|
end
|
|
254
286
|
```
|
|
255
287
|
|
|
256
|
-
#### Using the
|
|
288
|
+
#### Using the list_companies_analytics_customers_with_http_info variant
|
|
257
289
|
|
|
258
290
|
This returns an Array which contains the response data, status code and headers.
|
|
259
291
|
|
|
260
|
-
> <Array(<
|
|
292
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_analytics_customers_with_http_info(company_id, opts)
|
|
261
293
|
|
|
262
294
|
```ruby
|
|
263
295
|
begin
|
|
264
|
-
# Get
|
|
265
|
-
data, status_code, headers = api_instance.
|
|
296
|
+
# Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
|
|
297
|
+
data, status_code, headers = api_instance.list_companies_analytics_customers_with_http_info(company_id, opts)
|
|
266
298
|
p status_code # => 2xx
|
|
267
299
|
p headers # => { ... }
|
|
268
|
-
p data # => <
|
|
300
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
269
301
|
rescue SparteraApiSdk::ApiError => e
|
|
270
|
-
puts "Error when calling CompaniesApi->
|
|
302
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_customers_with_http_info: #{e}"
|
|
271
303
|
end
|
|
272
304
|
```
|
|
273
305
|
|
|
@@ -275,11 +307,16 @@ end
|
|
|
275
307
|
|
|
276
308
|
| Name | Type | Description | Notes |
|
|
277
309
|
| ---- | ---- | ----------- | ----- |
|
|
278
|
-
| **company_id** | **String** |
|
|
310
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
311
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
312
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
313
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
314
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
315
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
279
316
|
|
|
280
317
|
### Return type
|
|
281
318
|
|
|
282
|
-
[**
|
|
319
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
283
320
|
|
|
284
321
|
### Authorization
|
|
285
322
|
|
|
@@ -291,11 +328,11 @@ end
|
|
|
291
328
|
- **Accept**: application/json
|
|
292
329
|
|
|
293
330
|
|
|
294
|
-
##
|
|
331
|
+
## list_companies_analytics_dashboard
|
|
295
332
|
|
|
296
|
-
> <
|
|
333
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_analytics_dashboard(company_id, opts)
|
|
297
334
|
|
|
298
|
-
Get
|
|
335
|
+
Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
|
|
299
336
|
|
|
300
337
|
### Examples
|
|
301
338
|
|
|
@@ -311,32 +348,39 @@ SparteraApiSdk.configure do |config|
|
|
|
311
348
|
end
|
|
312
349
|
|
|
313
350
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
314
|
-
company_id = 'company_id_example' # String |
|
|
351
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
352
|
+
opts = {
|
|
353
|
+
page: 56, # Integer | Page number for pagination
|
|
354
|
+
limit: 56, # Integer | Number of items per page
|
|
355
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
356
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
357
|
+
search: 'search_example' # String | Search term to filter results
|
|
358
|
+
}
|
|
315
359
|
|
|
316
360
|
begin
|
|
317
|
-
# Get
|
|
318
|
-
result = api_instance.
|
|
361
|
+
# Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
|
|
362
|
+
result = api_instance.list_companies_analytics_dashboard(company_id, opts)
|
|
319
363
|
p result
|
|
320
364
|
rescue SparteraApiSdk::ApiError => e
|
|
321
|
-
puts "Error when calling CompaniesApi->
|
|
365
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_dashboard: #{e}"
|
|
322
366
|
end
|
|
323
367
|
```
|
|
324
368
|
|
|
325
|
-
#### Using the
|
|
369
|
+
#### Using the list_companies_analytics_dashboard_with_http_info variant
|
|
326
370
|
|
|
327
371
|
This returns an Array which contains the response data, status code and headers.
|
|
328
372
|
|
|
329
|
-
> <Array(<
|
|
373
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_analytics_dashboard_with_http_info(company_id, opts)
|
|
330
374
|
|
|
331
375
|
```ruby
|
|
332
376
|
begin
|
|
333
|
-
# Get
|
|
334
|
-
data, status_code, headers = api_instance.
|
|
377
|
+
# Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
|
|
378
|
+
data, status_code, headers = api_instance.list_companies_analytics_dashboard_with_http_info(company_id, opts)
|
|
335
379
|
p status_code # => 2xx
|
|
336
380
|
p headers # => { ... }
|
|
337
|
-
p data # => <
|
|
381
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
338
382
|
rescue SparteraApiSdk::ApiError => e
|
|
339
|
-
puts "Error when calling CompaniesApi->
|
|
383
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_dashboard_with_http_info: #{e}"
|
|
340
384
|
end
|
|
341
385
|
```
|
|
342
386
|
|
|
@@ -344,11 +388,16 @@ end
|
|
|
344
388
|
|
|
345
389
|
| Name | Type | Description | Notes |
|
|
346
390
|
| ---- | ---- | ----------- | ----- |
|
|
347
|
-
| **company_id** | **String** |
|
|
391
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
392
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
393
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
394
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
395
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
396
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
348
397
|
|
|
349
398
|
### Return type
|
|
350
399
|
|
|
351
|
-
[**
|
|
400
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
352
401
|
|
|
353
402
|
### Authorization
|
|
354
403
|
|
|
@@ -360,11 +409,11 @@ end
|
|
|
360
409
|
- **Accept**: application/json
|
|
361
410
|
|
|
362
411
|
|
|
363
|
-
##
|
|
412
|
+
## list_companies_analytics_metrics
|
|
364
413
|
|
|
365
|
-
> <
|
|
414
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_analytics_metrics(company_id, opts)
|
|
366
415
|
|
|
367
|
-
Get
|
|
416
|
+
Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
|
|
368
417
|
|
|
369
418
|
### Examples
|
|
370
419
|
|
|
@@ -380,32 +429,39 @@ SparteraApiSdk.configure do |config|
|
|
|
380
429
|
end
|
|
381
430
|
|
|
382
431
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
383
|
-
company_id = 'company_id_example' # String |
|
|
432
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
433
|
+
opts = {
|
|
434
|
+
page: 56, # Integer | Page number for pagination
|
|
435
|
+
limit: 56, # Integer | Number of items per page
|
|
436
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
437
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
438
|
+
search: 'search_example' # String | Search term to filter results
|
|
439
|
+
}
|
|
384
440
|
|
|
385
441
|
begin
|
|
386
|
-
# Get
|
|
387
|
-
result = api_instance.
|
|
442
|
+
# Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
|
|
443
|
+
result = api_instance.list_companies_analytics_metrics(company_id, opts)
|
|
388
444
|
p result
|
|
389
445
|
rescue SparteraApiSdk::ApiError => e
|
|
390
|
-
puts "Error when calling CompaniesApi->
|
|
446
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_metrics: #{e}"
|
|
391
447
|
end
|
|
392
448
|
```
|
|
393
449
|
|
|
394
|
-
#### Using the
|
|
450
|
+
#### Using the list_companies_analytics_metrics_with_http_info variant
|
|
395
451
|
|
|
396
452
|
This returns an Array which contains the response data, status code and headers.
|
|
397
453
|
|
|
398
|
-
> <Array(<
|
|
454
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_analytics_metrics_with_http_info(company_id, opts)
|
|
399
455
|
|
|
400
456
|
```ruby
|
|
401
457
|
begin
|
|
402
|
-
# Get
|
|
403
|
-
data, status_code, headers = api_instance.
|
|
458
|
+
# Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
|
|
459
|
+
data, status_code, headers = api_instance.list_companies_analytics_metrics_with_http_info(company_id, opts)
|
|
404
460
|
p status_code # => 2xx
|
|
405
461
|
p headers # => { ... }
|
|
406
|
-
p data # => <
|
|
462
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
407
463
|
rescue SparteraApiSdk::ApiError => e
|
|
408
|
-
puts "Error when calling CompaniesApi->
|
|
464
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_metrics_with_http_info: #{e}"
|
|
409
465
|
end
|
|
410
466
|
```
|
|
411
467
|
|
|
@@ -413,11 +469,16 @@ end
|
|
|
413
469
|
|
|
414
470
|
| Name | Type | Description | Notes |
|
|
415
471
|
| ---- | ---- | ----------- | ----- |
|
|
416
|
-
| **company_id** | **String** |
|
|
472
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
473
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
474
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
475
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
476
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
477
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
417
478
|
|
|
418
479
|
### Return type
|
|
419
480
|
|
|
420
|
-
[**
|
|
481
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
421
482
|
|
|
422
483
|
### Authorization
|
|
423
484
|
|
|
@@ -429,11 +490,11 @@ end
|
|
|
429
490
|
- **Accept**: application/json
|
|
430
491
|
|
|
431
492
|
|
|
432
|
-
##
|
|
493
|
+
## list_companies_analytics_sales
|
|
433
494
|
|
|
434
|
-
> <
|
|
495
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_analytics_sales(company_id, opts)
|
|
435
496
|
|
|
436
|
-
|
|
497
|
+
Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
437
498
|
|
|
438
499
|
### Examples
|
|
439
500
|
|
|
@@ -449,32 +510,39 @@ SparteraApiSdk.configure do |config|
|
|
|
449
510
|
end
|
|
450
511
|
|
|
451
512
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
452
|
-
company_id = 'company_id_example' # String |
|
|
513
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
514
|
+
opts = {
|
|
515
|
+
page: 56, # Integer | Page number for pagination
|
|
516
|
+
limit: 56, # Integer | Number of items per page
|
|
517
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
518
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
519
|
+
search: 'search_example' # String | Search term to filter results
|
|
520
|
+
}
|
|
453
521
|
|
|
454
522
|
begin
|
|
455
|
-
#
|
|
456
|
-
result = api_instance.
|
|
523
|
+
# Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
524
|
+
result = api_instance.list_companies_analytics_sales(company_id, opts)
|
|
457
525
|
p result
|
|
458
526
|
rescue SparteraApiSdk::ApiError => e
|
|
459
|
-
puts "Error when calling CompaniesApi->
|
|
527
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_sales: #{e}"
|
|
460
528
|
end
|
|
461
529
|
```
|
|
462
530
|
|
|
463
|
-
#### Using the
|
|
531
|
+
#### Using the list_companies_analytics_sales_with_http_info variant
|
|
464
532
|
|
|
465
533
|
This returns an Array which contains the response data, status code and headers.
|
|
466
534
|
|
|
467
|
-
> <Array(<
|
|
535
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_analytics_sales_with_http_info(company_id, opts)
|
|
468
536
|
|
|
469
537
|
```ruby
|
|
470
538
|
begin
|
|
471
|
-
#
|
|
472
|
-
data, status_code, headers = api_instance.
|
|
539
|
+
# Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
540
|
+
data, status_code, headers = api_instance.list_companies_analytics_sales_with_http_info(company_id, opts)
|
|
473
541
|
p status_code # => 2xx
|
|
474
542
|
p headers # => { ... }
|
|
475
|
-
p data # => <
|
|
543
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
476
544
|
rescue SparteraApiSdk::ApiError => e
|
|
477
|
-
puts "Error when calling CompaniesApi->
|
|
545
|
+
puts "Error when calling CompaniesApi->list_companies_analytics_sales_with_http_info: #{e}"
|
|
478
546
|
end
|
|
479
547
|
```
|
|
480
548
|
|
|
@@ -482,11 +550,16 @@ end
|
|
|
482
550
|
|
|
483
551
|
| Name | Type | Description | Notes |
|
|
484
552
|
| ---- | ---- | ----------- | ----- |
|
|
485
|
-
| **company_id** | **String** |
|
|
553
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
554
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
555
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
556
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
557
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
558
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
486
559
|
|
|
487
560
|
### Return type
|
|
488
561
|
|
|
489
|
-
[**
|
|
562
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
490
563
|
|
|
491
564
|
### Authorization
|
|
492
565
|
|
|
@@ -498,11 +571,11 @@ end
|
|
|
498
571
|
- **Accept**: application/json
|
|
499
572
|
|
|
500
573
|
|
|
501
|
-
##
|
|
574
|
+
## list_companies_objects
|
|
502
575
|
|
|
503
|
-
> <
|
|
576
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_objects(company_id, opts)
|
|
504
577
|
|
|
505
|
-
Get
|
|
578
|
+
Get all objects (connections, assets) of a single company
|
|
506
579
|
|
|
507
580
|
### Examples
|
|
508
581
|
|
|
@@ -518,32 +591,39 @@ SparteraApiSdk.configure do |config|
|
|
|
518
591
|
end
|
|
519
592
|
|
|
520
593
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
521
|
-
company_id = 'company_id_example' # String |
|
|
594
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
595
|
+
opts = {
|
|
596
|
+
page: 56, # Integer | Page number for pagination
|
|
597
|
+
limit: 56, # Integer | Number of items per page
|
|
598
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
599
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
600
|
+
search: 'search_example' # String | Search term to filter results
|
|
601
|
+
}
|
|
522
602
|
|
|
523
603
|
begin
|
|
524
|
-
# Get
|
|
525
|
-
result = api_instance.
|
|
604
|
+
# Get all objects (connections, assets) of a single company
|
|
605
|
+
result = api_instance.list_companies_objects(company_id, opts)
|
|
526
606
|
p result
|
|
527
607
|
rescue SparteraApiSdk::ApiError => e
|
|
528
|
-
puts "Error when calling CompaniesApi->
|
|
608
|
+
puts "Error when calling CompaniesApi->list_companies_objects: #{e}"
|
|
529
609
|
end
|
|
530
610
|
```
|
|
531
611
|
|
|
532
|
-
#### Using the
|
|
612
|
+
#### Using the list_companies_objects_with_http_info variant
|
|
533
613
|
|
|
534
614
|
This returns an Array which contains the response data, status code and headers.
|
|
535
615
|
|
|
536
|
-
> <Array(<
|
|
616
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_objects_with_http_info(company_id, opts)
|
|
537
617
|
|
|
538
618
|
```ruby
|
|
539
619
|
begin
|
|
540
|
-
# Get
|
|
541
|
-
data, status_code, headers = api_instance.
|
|
620
|
+
# Get all objects (connections, assets) of a single company
|
|
621
|
+
data, status_code, headers = api_instance.list_companies_objects_with_http_info(company_id, opts)
|
|
542
622
|
p status_code # => 2xx
|
|
543
623
|
p headers # => { ... }
|
|
544
|
-
p data # => <
|
|
624
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
545
625
|
rescue SparteraApiSdk::ApiError => e
|
|
546
|
-
puts "Error when calling CompaniesApi->
|
|
626
|
+
puts "Error when calling CompaniesApi->list_companies_objects_with_http_info: #{e}"
|
|
547
627
|
end
|
|
548
628
|
```
|
|
549
629
|
|
|
@@ -551,11 +631,16 @@ end
|
|
|
551
631
|
|
|
552
632
|
| Name | Type | Description | Notes |
|
|
553
633
|
| ---- | ---- | ----------- | ----- |
|
|
554
|
-
| **company_id** | **String** |
|
|
634
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
635
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
636
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
637
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
638
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
639
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
555
640
|
|
|
556
641
|
### Return type
|
|
557
642
|
|
|
558
|
-
[**
|
|
643
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
559
644
|
|
|
560
645
|
### Authorization
|
|
561
646
|
|
|
@@ -567,11 +652,11 @@ end
|
|
|
567
652
|
- **Accept**: application/json
|
|
568
653
|
|
|
569
654
|
|
|
570
|
-
##
|
|
655
|
+
## list_companies_requests_usage
|
|
571
656
|
|
|
572
|
-
> <
|
|
657
|
+
> <ListCompaniesAnalyticsAssets200Response> list_companies_requests_usage(company_id, opts)
|
|
573
658
|
|
|
574
|
-
Get company request usage data for a specific month.
|
|
659
|
+
Get company request usage data for a specific month.
|
|
575
660
|
|
|
576
661
|
### Examples
|
|
577
662
|
|
|
@@ -587,32 +672,39 @@ SparteraApiSdk.configure do |config|
|
|
|
587
672
|
end
|
|
588
673
|
|
|
589
674
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
590
|
-
company_id = 'company_id_example' # String |
|
|
675
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
676
|
+
opts = {
|
|
677
|
+
page: 56, # Integer | Page number for pagination
|
|
678
|
+
limit: 56, # Integer | Number of items per page
|
|
679
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
680
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
681
|
+
search: 'search_example' # String | Search term to filter results
|
|
682
|
+
}
|
|
591
683
|
|
|
592
684
|
begin
|
|
593
|
-
# Get company request usage data for a specific month.
|
|
594
|
-
result = api_instance.
|
|
685
|
+
# Get company request usage data for a specific month.
|
|
686
|
+
result = api_instance.list_companies_requests_usage(company_id, opts)
|
|
595
687
|
p result
|
|
596
688
|
rescue SparteraApiSdk::ApiError => e
|
|
597
|
-
puts "Error when calling CompaniesApi->
|
|
689
|
+
puts "Error when calling CompaniesApi->list_companies_requests_usage: #{e}"
|
|
598
690
|
end
|
|
599
691
|
```
|
|
600
692
|
|
|
601
|
-
#### Using the
|
|
693
|
+
#### Using the list_companies_requests_usage_with_http_info variant
|
|
602
694
|
|
|
603
695
|
This returns an Array which contains the response data, status code and headers.
|
|
604
696
|
|
|
605
|
-
> <Array(<
|
|
697
|
+
> <Array(<ListCompaniesAnalyticsAssets200Response>, Integer, Hash)> list_companies_requests_usage_with_http_info(company_id, opts)
|
|
606
698
|
|
|
607
699
|
```ruby
|
|
608
700
|
begin
|
|
609
|
-
# Get company request usage data for a specific month.
|
|
610
|
-
data, status_code, headers = api_instance.
|
|
701
|
+
# Get company request usage data for a specific month.
|
|
702
|
+
data, status_code, headers = api_instance.list_companies_requests_usage_with_http_info(company_id, opts)
|
|
611
703
|
p status_code # => 2xx
|
|
612
704
|
p headers # => { ... }
|
|
613
|
-
p data # => <
|
|
705
|
+
p data # => <ListCompaniesAnalyticsAssets200Response>
|
|
614
706
|
rescue SparteraApiSdk::ApiError => e
|
|
615
|
-
puts "Error when calling CompaniesApi->
|
|
707
|
+
puts "Error when calling CompaniesApi->list_companies_requests_usage_with_http_info: #{e}"
|
|
616
708
|
end
|
|
617
709
|
```
|
|
618
710
|
|
|
@@ -620,11 +712,16 @@ end
|
|
|
620
712
|
|
|
621
713
|
| Name | Type | Description | Notes |
|
|
622
714
|
| ---- | ---- | ----------- | ----- |
|
|
623
|
-
| **company_id** | **String** |
|
|
715
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
716
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
717
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
718
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
719
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
720
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
624
721
|
|
|
625
722
|
### Return type
|
|
626
723
|
|
|
627
|
-
[**
|
|
724
|
+
[**ListCompaniesAnalyticsAssets200Response**](ListCompaniesAnalyticsAssets200Response.md)
|
|
628
725
|
|
|
629
726
|
### Authorization
|
|
630
727
|
|
|
@@ -635,3 +732,74 @@ end
|
|
|
635
732
|
- **Content-Type**: Not defined
|
|
636
733
|
- **Accept**: application/json
|
|
637
734
|
|
|
735
|
+
|
|
736
|
+
## update_companies
|
|
737
|
+
|
|
738
|
+
> <UpdateCompanies200Response> update_companies(company_id, companies_update)
|
|
739
|
+
|
|
740
|
+
Update an existing company by ID
|
|
741
|
+
|
|
742
|
+
### Examples
|
|
743
|
+
|
|
744
|
+
```ruby
|
|
745
|
+
require 'time'
|
|
746
|
+
require 'spartera_api_sdk'
|
|
747
|
+
# setup authorization
|
|
748
|
+
SparteraApiSdk.configure do |config|
|
|
749
|
+
# Configure API key authorization: ApiKeyAuth
|
|
750
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
752
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
753
|
+
end
|
|
754
|
+
|
|
755
|
+
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
756
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
757
|
+
companies_update = SparteraApiSdk::CompaniesUpdate.new # CompaniesUpdate |
|
|
758
|
+
|
|
759
|
+
begin
|
|
760
|
+
# Update an existing company by ID
|
|
761
|
+
result = api_instance.update_companies(company_id, companies_update)
|
|
762
|
+
p result
|
|
763
|
+
rescue SparteraApiSdk::ApiError => e
|
|
764
|
+
puts "Error when calling CompaniesApi->update_companies: #{e}"
|
|
765
|
+
end
|
|
766
|
+
```
|
|
767
|
+
|
|
768
|
+
#### Using the update_companies_with_http_info variant
|
|
769
|
+
|
|
770
|
+
This returns an Array which contains the response data, status code and headers.
|
|
771
|
+
|
|
772
|
+
> <Array(<UpdateCompanies200Response>, Integer, Hash)> update_companies_with_http_info(company_id, companies_update)
|
|
773
|
+
|
|
774
|
+
```ruby
|
|
775
|
+
begin
|
|
776
|
+
# Update an existing company by ID
|
|
777
|
+
data, status_code, headers = api_instance.update_companies_with_http_info(company_id, companies_update)
|
|
778
|
+
p status_code # => 2xx
|
|
779
|
+
p headers # => { ... }
|
|
780
|
+
p data # => <UpdateCompanies200Response>
|
|
781
|
+
rescue SparteraApiSdk::ApiError => e
|
|
782
|
+
puts "Error when calling CompaniesApi->update_companies_with_http_info: #{e}"
|
|
783
|
+
end
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
### Parameters
|
|
787
|
+
|
|
788
|
+
| Name | Type | Description | Notes |
|
|
789
|
+
| ---- | ---- | ----------- | ----- |
|
|
790
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
791
|
+
| **companies_update** | [**CompaniesUpdate**](CompaniesUpdate.md) | | |
|
|
792
|
+
|
|
793
|
+
### Return type
|
|
794
|
+
|
|
795
|
+
[**UpdateCompanies200Response**](UpdateCompanies200Response.md)
|
|
796
|
+
|
|
797
|
+
### Authorization
|
|
798
|
+
|
|
799
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
800
|
+
|
|
801
|
+
### HTTP request headers
|
|
802
|
+
|
|
803
|
+
- **Content-Type**: application/json
|
|
804
|
+
- **Accept**: application/json
|
|
805
|
+
|