spartera_api_sdk 0.4.2 → 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 +78 -616
- data/CHANGELOG.md +0 -25
- 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/CompaniesApi.md
CHANGED
|
@@ -4,23 +4,22 @@ 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
|
-
| [**
|
|
16
|
-
| [**update_companies**](CompaniesApi.md#update_companies) | **PATCH** /companies/{company_id} | Update an existing company by ID |
|
|
7
|
+
| [**companies_company_id_analytics_assets_get**](CompaniesApi.md#companies_company_id_analytics_assets_get) | **GET** /companies/{company_id}/analytics/assets | Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include |
|
|
8
|
+
| [**companies_company_id_analytics_customers_get**](CompaniesApi.md#companies_company_id_analytics_customers_get) | **GET** /companies/{company_id}/analytics/customers | Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by |
|
|
9
|
+
| [**companies_company_id_analytics_dashboard_get**](CompaniesApi.md#companies_company_id_analytics_dashboard_get) | **GET** /companies/{company_id}/analytics/dashboard | Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter) |
|
|
10
|
+
| [**companies_company_id_analytics_sales_get**](CompaniesApi.md#companies_company_id_analytics_sales_get) | **GET** /companies/{company_id}/analytics/sales | Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics |
|
|
11
|
+
| [**companies_company_id_get**](CompaniesApi.md#companies_company_id_get) | **GET** /companies/{company_id} | Get details of the requestor's own company |
|
|
12
|
+
| [**companies_company_id_objects_get**](CompaniesApi.md#companies_company_id_objects_get) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company |
|
|
13
|
+
| [**companies_company_id_patch**](CompaniesApi.md#companies_company_id_patch) | **PATCH** /companies/{company_id} | Update an existing company by ID |
|
|
14
|
+
| [**companies_company_id_requests_plan_get**](CompaniesApi.md#companies_company_id_requests_plan_get) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company's current subscription plan. |
|
|
15
|
+
| [**companies_company_id_requests_usage_get**](CompaniesApi.md#companies_company_id_requests_usage_get) | **GET** /companies/{company_id}/requests/usage | Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included. |
|
|
17
16
|
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## companies_company_id_analytics_assets_get
|
|
20
19
|
|
|
21
|
-
>
|
|
20
|
+
> Object companies_company_id_analytics_assets_get(company_id)
|
|
22
21
|
|
|
23
|
-
Get
|
|
22
|
+
Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include
|
|
24
23
|
|
|
25
24
|
### Examples
|
|
26
25
|
|
|
@@ -29,39 +28,37 @@ require 'time'
|
|
|
29
28
|
require 'spartera_api_sdk'
|
|
30
29
|
# setup authorization
|
|
31
30
|
SparteraApiSdk.configure do |config|
|
|
32
|
-
# Configure
|
|
33
|
-
config.
|
|
34
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
35
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
31
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
32
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
36
33
|
end
|
|
37
34
|
|
|
38
35
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
39
|
-
company_id = 'company_id_example' # String |
|
|
36
|
+
company_id = 'company_id_example' # String |
|
|
40
37
|
|
|
41
38
|
begin
|
|
42
|
-
# Get
|
|
43
|
-
result = api_instance.
|
|
39
|
+
# Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include
|
|
40
|
+
result = api_instance.companies_company_id_analytics_assets_get(company_id)
|
|
44
41
|
p result
|
|
45
42
|
rescue SparteraApiSdk::ApiError => e
|
|
46
|
-
puts "Error when calling CompaniesApi->
|
|
43
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get: #{e}"
|
|
47
44
|
end
|
|
48
45
|
```
|
|
49
46
|
|
|
50
|
-
#### Using the
|
|
47
|
+
#### Using the companies_company_id_analytics_assets_get_with_http_info variant
|
|
51
48
|
|
|
52
49
|
This returns an Array which contains the response data, status code and headers.
|
|
53
50
|
|
|
54
|
-
> <Array(
|
|
51
|
+
> <Array(Object, Integer, Hash)> companies_company_id_analytics_assets_get_with_http_info(company_id)
|
|
55
52
|
|
|
56
53
|
```ruby
|
|
57
54
|
begin
|
|
58
|
-
# Get
|
|
59
|
-
data, status_code, headers = api_instance.
|
|
55
|
+
# Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include
|
|
56
|
+
data, status_code, headers = api_instance.companies_company_id_analytics_assets_get_with_http_info(company_id)
|
|
60
57
|
p status_code # => 2xx
|
|
61
58
|
p headers # => { ... }
|
|
62
|
-
p data # =>
|
|
59
|
+
p data # => Object
|
|
63
60
|
rescue SparteraApiSdk::ApiError => e
|
|
64
|
-
puts "Error when calling CompaniesApi->
|
|
61
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get_with_http_info: #{e}"
|
|
65
62
|
end
|
|
66
63
|
```
|
|
67
64
|
|
|
@@ -69,15 +66,15 @@ end
|
|
|
69
66
|
|
|
70
67
|
| Name | Type | Description | Notes |
|
|
71
68
|
| ---- | ---- | ----------- | ----- |
|
|
72
|
-
| **company_id** | **String** |
|
|
69
|
+
| **company_id** | **String** | | |
|
|
73
70
|
|
|
74
71
|
### Return type
|
|
75
72
|
|
|
76
|
-
|
|
73
|
+
**Object**
|
|
77
74
|
|
|
78
75
|
### Authorization
|
|
79
76
|
|
|
80
|
-
[
|
|
77
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
81
78
|
|
|
82
79
|
### HTTP request headers
|
|
83
80
|
|
|
@@ -85,11 +82,11 @@ end
|
|
|
85
82
|
- **Accept**: application/json
|
|
86
83
|
|
|
87
84
|
|
|
88
|
-
##
|
|
85
|
+
## companies_company_id_analytics_customers_get
|
|
89
86
|
|
|
90
|
-
>
|
|
87
|
+
> Object companies_company_id_analytics_customers_get(company_id)
|
|
91
88
|
|
|
92
|
-
Get
|
|
89
|
+
Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by
|
|
93
90
|
|
|
94
91
|
### Examples
|
|
95
92
|
|
|
@@ -98,46 +95,37 @@ require 'time'
|
|
|
98
95
|
require 'spartera_api_sdk'
|
|
99
96
|
# setup authorization
|
|
100
97
|
SparteraApiSdk.configure do |config|
|
|
101
|
-
# Configure
|
|
102
|
-
config.
|
|
103
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
104
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
98
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
99
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
105
100
|
end
|
|
106
101
|
|
|
107
102
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
108
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
103
|
+
company_id = 'company_id_example' # String |
|
|
116
104
|
|
|
117
105
|
begin
|
|
118
|
-
# Get
|
|
119
|
-
result = api_instance.
|
|
106
|
+
# Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by
|
|
107
|
+
result = api_instance.companies_company_id_analytics_customers_get(company_id)
|
|
120
108
|
p result
|
|
121
109
|
rescue SparteraApiSdk::ApiError => e
|
|
122
|
-
puts "Error when calling CompaniesApi->
|
|
110
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get: #{e}"
|
|
123
111
|
end
|
|
124
112
|
```
|
|
125
113
|
|
|
126
|
-
#### Using the
|
|
114
|
+
#### Using the companies_company_id_analytics_customers_get_with_http_info variant
|
|
127
115
|
|
|
128
116
|
This returns an Array which contains the response data, status code and headers.
|
|
129
117
|
|
|
130
|
-
> <Array(
|
|
118
|
+
> <Array(Object, Integer, Hash)> companies_company_id_analytics_customers_get_with_http_info(company_id)
|
|
131
119
|
|
|
132
120
|
```ruby
|
|
133
121
|
begin
|
|
134
|
-
# Get
|
|
135
|
-
data, status_code, headers = api_instance.
|
|
122
|
+
# Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by
|
|
123
|
+
data, status_code, headers = api_instance.companies_company_id_analytics_customers_get_with_http_info(company_id)
|
|
136
124
|
p status_code # => 2xx
|
|
137
125
|
p headers # => { ... }
|
|
138
|
-
p data # =>
|
|
126
|
+
p data # => Object
|
|
139
127
|
rescue SparteraApiSdk::ApiError => e
|
|
140
|
-
puts "Error when calling CompaniesApi->
|
|
128
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get_with_http_info: #{e}"
|
|
141
129
|
end
|
|
142
130
|
```
|
|
143
131
|
|
|
@@ -145,20 +133,15 @@ end
|
|
|
145
133
|
|
|
146
134
|
| Name | Type | Description | Notes |
|
|
147
135
|
| ---- | ---- | ----------- | ----- |
|
|
148
|
-
| **company_id** | **String** |
|
|
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] |
|
|
136
|
+
| **company_id** | **String** | | |
|
|
154
137
|
|
|
155
138
|
### Return type
|
|
156
139
|
|
|
157
|
-
|
|
140
|
+
**Object**
|
|
158
141
|
|
|
159
142
|
### Authorization
|
|
160
143
|
|
|
161
|
-
[
|
|
144
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
162
145
|
|
|
163
146
|
### HTTP request headers
|
|
164
147
|
|
|
@@ -166,11 +149,11 @@ end
|
|
|
166
149
|
- **Accept**: application/json
|
|
167
150
|
|
|
168
151
|
|
|
169
|
-
##
|
|
152
|
+
## companies_company_id_analytics_dashboard_get
|
|
170
153
|
|
|
171
|
-
>
|
|
154
|
+
> Object companies_company_id_analytics_dashboard_get(company_id)
|
|
172
155
|
|
|
173
|
-
Get
|
|
156
|
+
Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
|
|
174
157
|
|
|
175
158
|
### Examples
|
|
176
159
|
|
|
@@ -179,46 +162,37 @@ require 'time'
|
|
|
179
162
|
require 'spartera_api_sdk'
|
|
180
163
|
# setup authorization
|
|
181
164
|
SparteraApiSdk.configure do |config|
|
|
182
|
-
# Configure
|
|
183
|
-
config.
|
|
184
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
185
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
165
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
166
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
186
167
|
end
|
|
187
168
|
|
|
188
169
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
189
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
170
|
+
company_id = 'company_id_example' # String |
|
|
197
171
|
|
|
198
172
|
begin
|
|
199
|
-
# Get
|
|
200
|
-
result = api_instance.
|
|
173
|
+
# Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
|
|
174
|
+
result = api_instance.companies_company_id_analytics_dashboard_get(company_id)
|
|
201
175
|
p result
|
|
202
176
|
rescue SparteraApiSdk::ApiError => e
|
|
203
|
-
puts "Error when calling CompaniesApi->
|
|
177
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get: #{e}"
|
|
204
178
|
end
|
|
205
179
|
```
|
|
206
180
|
|
|
207
|
-
#### Using the
|
|
181
|
+
#### Using the companies_company_id_analytics_dashboard_get_with_http_info variant
|
|
208
182
|
|
|
209
183
|
This returns an Array which contains the response data, status code and headers.
|
|
210
184
|
|
|
211
|
-
> <Array(
|
|
185
|
+
> <Array(Object, Integer, Hash)> companies_company_id_analytics_dashboard_get_with_http_info(company_id)
|
|
212
186
|
|
|
213
187
|
```ruby
|
|
214
188
|
begin
|
|
215
|
-
# Get
|
|
216
|
-
data, status_code, headers = api_instance.
|
|
189
|
+
# Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
|
|
190
|
+
data, status_code, headers = api_instance.companies_company_id_analytics_dashboard_get_with_http_info(company_id)
|
|
217
191
|
p status_code # => 2xx
|
|
218
192
|
p headers # => { ... }
|
|
219
|
-
p data # =>
|
|
193
|
+
p data # => Object
|
|
220
194
|
rescue SparteraApiSdk::ApiError => e
|
|
221
|
-
puts "Error when calling CompaniesApi->
|
|
195
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get_with_http_info: #{e}"
|
|
222
196
|
end
|
|
223
197
|
```
|
|
224
198
|
|
|
@@ -226,20 +200,15 @@ end
|
|
|
226
200
|
|
|
227
201
|
| Name | Type | Description | Notes |
|
|
228
202
|
| ---- | ---- | ----------- | ----- |
|
|
229
|
-
| **company_id** | **String** |
|
|
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] |
|
|
203
|
+
| **company_id** | **String** | | |
|
|
235
204
|
|
|
236
205
|
### Return type
|
|
237
206
|
|
|
238
|
-
|
|
207
|
+
**Object**
|
|
239
208
|
|
|
240
209
|
### Authorization
|
|
241
210
|
|
|
242
|
-
[
|
|
211
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
243
212
|
|
|
244
213
|
### HTTP request headers
|
|
245
214
|
|
|
@@ -247,11 +216,11 @@ end
|
|
|
247
216
|
- **Accept**: application/json
|
|
248
217
|
|
|
249
218
|
|
|
250
|
-
##
|
|
219
|
+
## companies_company_id_analytics_sales_get
|
|
251
220
|
|
|
252
|
-
>
|
|
221
|
+
> Object companies_company_id_analytics_sales_get(company_id)
|
|
253
222
|
|
|
254
|
-
Get
|
|
223
|
+
Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
255
224
|
|
|
256
225
|
### Examples
|
|
257
226
|
|
|
@@ -260,46 +229,37 @@ require 'time'
|
|
|
260
229
|
require 'spartera_api_sdk'
|
|
261
230
|
# setup authorization
|
|
262
231
|
SparteraApiSdk.configure do |config|
|
|
263
|
-
# Configure
|
|
264
|
-
config.
|
|
265
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
266
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
232
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
233
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
267
234
|
end
|
|
268
235
|
|
|
269
236
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
270
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
237
|
+
company_id = 'company_id_example' # String |
|
|
278
238
|
|
|
279
239
|
begin
|
|
280
|
-
# Get
|
|
281
|
-
result = api_instance.
|
|
240
|
+
# Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
241
|
+
result = api_instance.companies_company_id_analytics_sales_get(company_id)
|
|
282
242
|
p result
|
|
283
243
|
rescue SparteraApiSdk::ApiError => e
|
|
284
|
-
puts "Error when calling CompaniesApi->
|
|
244
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get: #{e}"
|
|
285
245
|
end
|
|
286
246
|
```
|
|
287
247
|
|
|
288
|
-
#### Using the
|
|
248
|
+
#### Using the companies_company_id_analytics_sales_get_with_http_info variant
|
|
289
249
|
|
|
290
250
|
This returns an Array which contains the response data, status code and headers.
|
|
291
251
|
|
|
292
|
-
> <Array(
|
|
252
|
+
> <Array(Object, Integer, Hash)> companies_company_id_analytics_sales_get_with_http_info(company_id)
|
|
293
253
|
|
|
294
254
|
```ruby
|
|
295
255
|
begin
|
|
296
|
-
# Get
|
|
297
|
-
data, status_code, headers = api_instance.
|
|
256
|
+
# Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
|
257
|
+
data, status_code, headers = api_instance.companies_company_id_analytics_sales_get_with_http_info(company_id)
|
|
298
258
|
p status_code # => 2xx
|
|
299
259
|
p headers # => { ... }
|
|
300
|
-
p data # =>
|
|
260
|
+
p data # => Object
|
|
301
261
|
rescue SparteraApiSdk::ApiError => e
|
|
302
|
-
puts "Error when calling CompaniesApi->
|
|
262
|
+
puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get_with_http_info: #{e}"
|
|
303
263
|
end
|
|
304
264
|
```
|
|
305
265
|
|
|
@@ -307,20 +267,15 @@ end
|
|
|
307
267
|
|
|
308
268
|
| Name | Type | Description | Notes |
|
|
309
269
|
| ---- | ---- | ----------- | ----- |
|
|
310
|
-
| **company_id** | **String** |
|
|
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] |
|
|
270
|
+
| **company_id** | **String** | | |
|
|
316
271
|
|
|
317
272
|
### Return type
|
|
318
273
|
|
|
319
|
-
|
|
274
|
+
**Object**
|
|
320
275
|
|
|
321
276
|
### Authorization
|
|
322
277
|
|
|
323
|
-
[
|
|
278
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
324
279
|
|
|
325
280
|
### HTTP request headers
|
|
326
281
|
|
|
@@ -328,11 +283,11 @@ end
|
|
|
328
283
|
- **Accept**: application/json
|
|
329
284
|
|
|
330
285
|
|
|
331
|
-
##
|
|
286
|
+
## companies_company_id_get
|
|
332
287
|
|
|
333
|
-
>
|
|
288
|
+
> Object companies_company_id_get(company_id)
|
|
334
289
|
|
|
335
|
-
Get
|
|
290
|
+
Get details of the requestor's own company
|
|
336
291
|
|
|
337
292
|
### Examples
|
|
338
293
|
|
|
@@ -341,46 +296,37 @@ require 'time'
|
|
|
341
296
|
require 'spartera_api_sdk'
|
|
342
297
|
# setup authorization
|
|
343
298
|
SparteraApiSdk.configure do |config|
|
|
344
|
-
# Configure
|
|
345
|
-
config.
|
|
346
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
347
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
299
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
300
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
348
301
|
end
|
|
349
302
|
|
|
350
303
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
351
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
304
|
+
company_id = 'company_id_example' # String |
|
|
359
305
|
|
|
360
306
|
begin
|
|
361
|
-
# Get
|
|
362
|
-
result = api_instance.
|
|
307
|
+
# Get details of the requestor's own company
|
|
308
|
+
result = api_instance.companies_company_id_get(company_id)
|
|
363
309
|
p result
|
|
364
310
|
rescue SparteraApiSdk::ApiError => e
|
|
365
|
-
puts "Error when calling CompaniesApi->
|
|
311
|
+
puts "Error when calling CompaniesApi->companies_company_id_get: #{e}"
|
|
366
312
|
end
|
|
367
313
|
```
|
|
368
314
|
|
|
369
|
-
#### Using the
|
|
315
|
+
#### Using the companies_company_id_get_with_http_info variant
|
|
370
316
|
|
|
371
317
|
This returns an Array which contains the response data, status code and headers.
|
|
372
318
|
|
|
373
|
-
> <Array(
|
|
319
|
+
> <Array(Object, Integer, Hash)> companies_company_id_get_with_http_info(company_id)
|
|
374
320
|
|
|
375
321
|
```ruby
|
|
376
322
|
begin
|
|
377
|
-
# Get
|
|
378
|
-
data, status_code, headers = api_instance.
|
|
323
|
+
# Get details of the requestor's own company
|
|
324
|
+
data, status_code, headers = api_instance.companies_company_id_get_with_http_info(company_id)
|
|
379
325
|
p status_code # => 2xx
|
|
380
326
|
p headers # => { ... }
|
|
381
|
-
p data # =>
|
|
327
|
+
p data # => Object
|
|
382
328
|
rescue SparteraApiSdk::ApiError => e
|
|
383
|
-
puts "Error when calling CompaniesApi->
|
|
329
|
+
puts "Error when calling CompaniesApi->companies_company_id_get_with_http_info: #{e}"
|
|
384
330
|
end
|
|
385
331
|
```
|
|
386
332
|
|
|
@@ -388,20 +334,15 @@ end
|
|
|
388
334
|
|
|
389
335
|
| Name | Type | Description | Notes |
|
|
390
336
|
| ---- | ---- | ----------- | ----- |
|
|
391
|
-
| **company_id** | **String** |
|
|
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] |
|
|
337
|
+
| **company_id** | **String** | | |
|
|
397
338
|
|
|
398
339
|
### Return type
|
|
399
340
|
|
|
400
|
-
|
|
341
|
+
**Object**
|
|
401
342
|
|
|
402
343
|
### Authorization
|
|
403
344
|
|
|
404
|
-
[
|
|
345
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
405
346
|
|
|
406
347
|
### HTTP request headers
|
|
407
348
|
|
|
@@ -409,11 +350,11 @@ end
|
|
|
409
350
|
- **Accept**: application/json
|
|
410
351
|
|
|
411
352
|
|
|
412
|
-
##
|
|
353
|
+
## companies_company_id_objects_get
|
|
413
354
|
|
|
414
|
-
>
|
|
355
|
+
> Object companies_company_id_objects_get(company_id)
|
|
415
356
|
|
|
416
|
-
Get
|
|
357
|
+
Get all objects (connections, assets) of a single company
|
|
417
358
|
|
|
418
359
|
### Examples
|
|
419
360
|
|
|
@@ -422,46 +363,37 @@ require 'time'
|
|
|
422
363
|
require 'spartera_api_sdk'
|
|
423
364
|
# setup authorization
|
|
424
365
|
SparteraApiSdk.configure do |config|
|
|
425
|
-
# Configure
|
|
426
|
-
config.
|
|
427
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
428
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
366
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
367
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
429
368
|
end
|
|
430
369
|
|
|
431
370
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
432
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
371
|
+
company_id = 'company_id_example' # String |
|
|
440
372
|
|
|
441
373
|
begin
|
|
442
|
-
# Get
|
|
443
|
-
result = api_instance.
|
|
374
|
+
# Get all objects (connections, assets) of a single company
|
|
375
|
+
result = api_instance.companies_company_id_objects_get(company_id)
|
|
444
376
|
p result
|
|
445
377
|
rescue SparteraApiSdk::ApiError => e
|
|
446
|
-
puts "Error when calling CompaniesApi->
|
|
378
|
+
puts "Error when calling CompaniesApi->companies_company_id_objects_get: #{e}"
|
|
447
379
|
end
|
|
448
380
|
```
|
|
449
381
|
|
|
450
|
-
#### Using the
|
|
382
|
+
#### Using the companies_company_id_objects_get_with_http_info variant
|
|
451
383
|
|
|
452
384
|
This returns an Array which contains the response data, status code and headers.
|
|
453
385
|
|
|
454
|
-
> <Array(
|
|
386
|
+
> <Array(Object, Integer, Hash)> companies_company_id_objects_get_with_http_info(company_id)
|
|
455
387
|
|
|
456
388
|
```ruby
|
|
457
389
|
begin
|
|
458
|
-
# Get
|
|
459
|
-
data, status_code, headers = api_instance.
|
|
390
|
+
# Get all objects (connections, assets) of a single company
|
|
391
|
+
data, status_code, headers = api_instance.companies_company_id_objects_get_with_http_info(company_id)
|
|
460
392
|
p status_code # => 2xx
|
|
461
393
|
p headers # => { ... }
|
|
462
|
-
p data # =>
|
|
394
|
+
p data # => Object
|
|
463
395
|
rescue SparteraApiSdk::ApiError => e
|
|
464
|
-
puts "Error when calling CompaniesApi->
|
|
396
|
+
puts "Error when calling CompaniesApi->companies_company_id_objects_get_with_http_info: #{e}"
|
|
465
397
|
end
|
|
466
398
|
```
|
|
467
399
|
|
|
@@ -469,20 +401,15 @@ end
|
|
|
469
401
|
|
|
470
402
|
| Name | Type | Description | Notes |
|
|
471
403
|
| ---- | ---- | ----------- | ----- |
|
|
472
|
-
| **company_id** | **String** |
|
|
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] |
|
|
404
|
+
| **company_id** | **String** | | |
|
|
478
405
|
|
|
479
406
|
### Return type
|
|
480
407
|
|
|
481
|
-
|
|
408
|
+
**Object**
|
|
482
409
|
|
|
483
410
|
### Authorization
|
|
484
411
|
|
|
485
|
-
[
|
|
412
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
486
413
|
|
|
487
414
|
### HTTP request headers
|
|
488
415
|
|
|
@@ -490,11 +417,11 @@ end
|
|
|
490
417
|
- **Accept**: application/json
|
|
491
418
|
|
|
492
419
|
|
|
493
|
-
##
|
|
420
|
+
## companies_company_id_patch
|
|
494
421
|
|
|
495
|
-
>
|
|
422
|
+
> Object companies_company_id_patch(company_id)
|
|
496
423
|
|
|
497
|
-
|
|
424
|
+
Update an existing company by ID
|
|
498
425
|
|
|
499
426
|
### Examples
|
|
500
427
|
|
|
@@ -503,46 +430,37 @@ require 'time'
|
|
|
503
430
|
require 'spartera_api_sdk'
|
|
504
431
|
# setup authorization
|
|
505
432
|
SparteraApiSdk.configure do |config|
|
|
506
|
-
# Configure
|
|
507
|
-
config.
|
|
508
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
509
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
433
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
434
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
510
435
|
end
|
|
511
436
|
|
|
512
437
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
513
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
438
|
+
company_id = 'company_id_example' # String |
|
|
521
439
|
|
|
522
440
|
begin
|
|
523
|
-
#
|
|
524
|
-
result = api_instance.
|
|
441
|
+
# Update an existing company by ID
|
|
442
|
+
result = api_instance.companies_company_id_patch(company_id)
|
|
525
443
|
p result
|
|
526
444
|
rescue SparteraApiSdk::ApiError => e
|
|
527
|
-
puts "Error when calling CompaniesApi->
|
|
445
|
+
puts "Error when calling CompaniesApi->companies_company_id_patch: #{e}"
|
|
528
446
|
end
|
|
529
447
|
```
|
|
530
448
|
|
|
531
|
-
#### Using the
|
|
449
|
+
#### Using the companies_company_id_patch_with_http_info variant
|
|
532
450
|
|
|
533
451
|
This returns an Array which contains the response data, status code and headers.
|
|
534
452
|
|
|
535
|
-
> <Array(
|
|
453
|
+
> <Array(Object, Integer, Hash)> companies_company_id_patch_with_http_info(company_id)
|
|
536
454
|
|
|
537
455
|
```ruby
|
|
538
456
|
begin
|
|
539
|
-
#
|
|
540
|
-
data, status_code, headers = api_instance.
|
|
457
|
+
# Update an existing company by ID
|
|
458
|
+
data, status_code, headers = api_instance.companies_company_id_patch_with_http_info(company_id)
|
|
541
459
|
p status_code # => 2xx
|
|
542
460
|
p headers # => { ... }
|
|
543
|
-
p data # =>
|
|
461
|
+
p data # => Object
|
|
544
462
|
rescue SparteraApiSdk::ApiError => e
|
|
545
|
-
puts "Error when calling CompaniesApi->
|
|
463
|
+
puts "Error when calling CompaniesApi->companies_company_id_patch_with_http_info: #{e}"
|
|
546
464
|
end
|
|
547
465
|
```
|
|
548
466
|
|
|
@@ -550,20 +468,15 @@ end
|
|
|
550
468
|
|
|
551
469
|
| Name | Type | Description | Notes |
|
|
552
470
|
| ---- | ---- | ----------- | ----- |
|
|
553
|
-
| **company_id** | **String** |
|
|
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] |
|
|
471
|
+
| **company_id** | **String** | | |
|
|
559
472
|
|
|
560
473
|
### Return type
|
|
561
474
|
|
|
562
|
-
|
|
475
|
+
**Object**
|
|
563
476
|
|
|
564
477
|
### Authorization
|
|
565
478
|
|
|
566
|
-
[
|
|
479
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
567
480
|
|
|
568
481
|
### HTTP request headers
|
|
569
482
|
|
|
@@ -571,11 +484,11 @@ end
|
|
|
571
484
|
- **Accept**: application/json
|
|
572
485
|
|
|
573
486
|
|
|
574
|
-
##
|
|
487
|
+
## companies_company_id_requests_plan_get
|
|
575
488
|
|
|
576
|
-
>
|
|
489
|
+
> Object companies_company_id_requests_plan_get(company_id)
|
|
577
490
|
|
|
578
|
-
Get
|
|
491
|
+
Get the total number of requests allocated in the company's current subscription plan.
|
|
579
492
|
|
|
580
493
|
### Examples
|
|
581
494
|
|
|
@@ -584,46 +497,37 @@ require 'time'
|
|
|
584
497
|
require 'spartera_api_sdk'
|
|
585
498
|
# setup authorization
|
|
586
499
|
SparteraApiSdk.configure do |config|
|
|
587
|
-
# Configure
|
|
588
|
-
config.
|
|
589
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
590
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
500
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
501
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
591
502
|
end
|
|
592
503
|
|
|
593
504
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
594
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
505
|
+
company_id = 'company_id_example' # String |
|
|
602
506
|
|
|
603
507
|
begin
|
|
604
|
-
# Get
|
|
605
|
-
result = api_instance.
|
|
508
|
+
# Get the total number of requests allocated in the company's current subscription plan.
|
|
509
|
+
result = api_instance.companies_company_id_requests_plan_get(company_id)
|
|
606
510
|
p result
|
|
607
511
|
rescue SparteraApiSdk::ApiError => e
|
|
608
|
-
puts "Error when calling CompaniesApi->
|
|
512
|
+
puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get: #{e}"
|
|
609
513
|
end
|
|
610
514
|
```
|
|
611
515
|
|
|
612
|
-
#### Using the
|
|
516
|
+
#### Using the companies_company_id_requests_plan_get_with_http_info variant
|
|
613
517
|
|
|
614
518
|
This returns an Array which contains the response data, status code and headers.
|
|
615
519
|
|
|
616
|
-
> <Array(
|
|
520
|
+
> <Array(Object, Integer, Hash)> companies_company_id_requests_plan_get_with_http_info(company_id)
|
|
617
521
|
|
|
618
522
|
```ruby
|
|
619
523
|
begin
|
|
620
|
-
# Get
|
|
621
|
-
data, status_code, headers = api_instance.
|
|
524
|
+
# Get the total number of requests allocated in the company's current subscription plan.
|
|
525
|
+
data, status_code, headers = api_instance.companies_company_id_requests_plan_get_with_http_info(company_id)
|
|
622
526
|
p status_code # => 2xx
|
|
623
527
|
p headers # => { ... }
|
|
624
|
-
p data # =>
|
|
528
|
+
p data # => Object
|
|
625
529
|
rescue SparteraApiSdk::ApiError => e
|
|
626
|
-
puts "Error when calling CompaniesApi->
|
|
530
|
+
puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get_with_http_info: #{e}"
|
|
627
531
|
end
|
|
628
532
|
```
|
|
629
533
|
|
|
@@ -631,20 +535,15 @@ end
|
|
|
631
535
|
|
|
632
536
|
| Name | Type | Description | Notes |
|
|
633
537
|
| ---- | ---- | ----------- | ----- |
|
|
634
|
-
| **company_id** | **String** |
|
|
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] |
|
|
538
|
+
| **company_id** | **String** | | |
|
|
640
539
|
|
|
641
540
|
### Return type
|
|
642
541
|
|
|
643
|
-
|
|
542
|
+
**Object**
|
|
644
543
|
|
|
645
544
|
### Authorization
|
|
646
545
|
|
|
647
|
-
[
|
|
546
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
648
547
|
|
|
649
548
|
### HTTP request headers
|
|
650
549
|
|
|
@@ -652,11 +551,11 @@ end
|
|
|
652
551
|
- **Accept**: application/json
|
|
653
552
|
|
|
654
553
|
|
|
655
|
-
##
|
|
554
|
+
## companies_company_id_requests_usage_get
|
|
656
555
|
|
|
657
|
-
>
|
|
556
|
+
> Object companies_company_id_requests_usage_get(company_id)
|
|
658
557
|
|
|
659
|
-
Get company request usage data for a specific month.
|
|
558
|
+
Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
|
|
660
559
|
|
|
661
560
|
### Examples
|
|
662
561
|
|
|
@@ -665,46 +564,37 @@ require 'time'
|
|
|
665
564
|
require 'spartera_api_sdk'
|
|
666
565
|
# setup authorization
|
|
667
566
|
SparteraApiSdk.configure do |config|
|
|
668
|
-
# Configure
|
|
669
|
-
config.
|
|
670
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
671
|
-
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
567
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
568
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
672
569
|
end
|
|
673
570
|
|
|
674
571
|
api_instance = SparteraApiSdk::CompaniesApi.new
|
|
675
|
-
company_id = 'company_id_example' # String |
|
|
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
|
-
}
|
|
572
|
+
company_id = 'company_id_example' # String |
|
|
683
573
|
|
|
684
574
|
begin
|
|
685
|
-
# Get company request usage data for a specific month.
|
|
686
|
-
result = api_instance.
|
|
575
|
+
# Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
|
|
576
|
+
result = api_instance.companies_company_id_requests_usage_get(company_id)
|
|
687
577
|
p result
|
|
688
578
|
rescue SparteraApiSdk::ApiError => e
|
|
689
|
-
puts "Error when calling CompaniesApi->
|
|
579
|
+
puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get: #{e}"
|
|
690
580
|
end
|
|
691
581
|
```
|
|
692
582
|
|
|
693
|
-
#### Using the
|
|
583
|
+
#### Using the companies_company_id_requests_usage_get_with_http_info variant
|
|
694
584
|
|
|
695
585
|
This returns an Array which contains the response data, status code and headers.
|
|
696
586
|
|
|
697
|
-
> <Array(
|
|
587
|
+
> <Array(Object, Integer, Hash)> companies_company_id_requests_usage_get_with_http_info(company_id)
|
|
698
588
|
|
|
699
589
|
```ruby
|
|
700
590
|
begin
|
|
701
|
-
# Get company request usage data for a specific month.
|
|
702
|
-
data, status_code, headers = api_instance.
|
|
591
|
+
# Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
|
|
592
|
+
data, status_code, headers = api_instance.companies_company_id_requests_usage_get_with_http_info(company_id)
|
|
703
593
|
p status_code # => 2xx
|
|
704
594
|
p headers # => { ... }
|
|
705
|
-
p data # =>
|
|
595
|
+
p data # => Object
|
|
706
596
|
rescue SparteraApiSdk::ApiError => e
|
|
707
|
-
puts "Error when calling CompaniesApi->
|
|
597
|
+
puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get_with_http_info: #{e}"
|
|
708
598
|
end
|
|
709
599
|
```
|
|
710
600
|
|
|
@@ -712,94 +602,18 @@ end
|
|
|
712
602
|
|
|
713
603
|
| Name | Type | Description | Notes |
|
|
714
604
|
| ---- | ---- | ----------- | ----- |
|
|
715
|
-
| **company_id** | **String** |
|
|
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] |
|
|
605
|
+
| **company_id** | **String** | | |
|
|
721
606
|
|
|
722
607
|
### Return type
|
|
723
608
|
|
|
724
|
-
|
|
609
|
+
**Object**
|
|
725
610
|
|
|
726
611
|
### Authorization
|
|
727
612
|
|
|
728
|
-
[
|
|
613
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
729
614
|
|
|
730
615
|
### HTTP request headers
|
|
731
616
|
|
|
732
617
|
- **Content-Type**: Not defined
|
|
733
618
|
- **Accept**: application/json
|
|
734
619
|
|
|
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
|
-
|