spartera_api_sdk 1.0.77 → 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 +150 -126
- data/docs/Alerts.md +13 -13
- data/docs/AlertsApi.md +139 -139
- data/docs/AlertsInput.md +7 -7
- data/docs/AlertsUpdate.md +7 -7
- data/docs/ApiKeys.md +19 -11
- data/docs/ApiKeysInput.md +13 -5
- data/docs/ApiKeysUpdate.md +13 -5
- data/docs/AssetPriceHistory.md +14 -12
- data/docs/AssetPriceHistoryApi.md +164 -164
- data/docs/AssetPriceHistoryInput.md +8 -6
- data/docs/AssetPriceHistoryUpdate.md +8 -6
- data/docs/AssetUsecases.md +28 -0
- data/docs/AssetUsecasesApi.md +157 -0
- data/docs/Assets.md +113 -83
- data/docs/AssetsApi.md +534 -206
- data/docs/AssetsInput.md +100 -70
- data/docs/AssetsUpdate.md +100 -70
- data/docs/CloudProviders.md +12 -12
- data/docs/CloudProvidersApi.md +44 -31
- data/docs/CloudProvidersInput.md +6 -6
- data/docs/CloudProvidersUpdate.md +6 -6
- data/docs/Companies.md +27 -23
- data/docs/CompaniesApi.md +313 -147
- data/docs/CompaniesInput.md +21 -17
- data/docs/CompaniesUpdate.md +21 -17
- data/docs/Connections.md +22 -22
- data/docs/ConnectionsApi.md +149 -125
- data/docs/ConnectionsInput.md +16 -16
- data/docs/ConnectionsUpdate.md +16 -16
- data/docs/CreateAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md → CreateAlerts200ResponseData.md} +2 -2
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/{CompaniesCompanyIdApiKeysPost200ResponseData.md → CreateApiKeys200ResponseData.md} +2 -2
- data/docs/{CompaniesCompanyIdPatch200Response.md → CreateAssetPriceHistory200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesPost200ResponseData.md → CreateAssetPriceHistory200ResponseData.md} +2 -2
- 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/CreatePosts200Response.md +20 -0
- 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/{CompaniesCompanyIdApiKeysApiKeyIdDelete200ResponseData.md → DeleteApiKeys200ResponseData.md} +2 -2
- data/docs/DeleteAssetPriceHistory200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200ResponseData.md → DeleteAssetPriceHistory200ResponseData.md} +2 -2
- 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 +15 -15
- data/docs/FavoritesApi.md +159 -159
- data/docs/FavoritesInput.md +9 -9
- data/docs/FavoritesUpdate.md +9 -9
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response.md → GetAlertsById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdApiKeysApiKeyIdGet200Response.md → GetApiKeysById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response.md → GetAssetPriceHistoryById200Response.md} +2 -2
- data/docs/GetAssetUsecasesById200Response.md +20 -0
- data/docs/{AnalyzeCompanyHandleAssetsAssetSlugGet200Response.md → GetAssetsByIdAnalyze200Response.md} +2 -2
- data/docs/{CloudProvidersProviderIdGet200Response.md → GetCloudProvidersById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdGet200Response.md → GetCompaniesById200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → GetConnectionsById200Response.md} +2 -2
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response.md → GetFavoritesById200Response.md} +2 -2
- data/docs/GetIndustriesById200Response.md +20 -0
- data/docs/{JobFunctionsFunctionIdGet200Response.md → GetJobFunctionsById200Response.md} +2 -2
- data/docs/GetPostgenIntegrationsById200Response.md +20 -0
- data/docs/GetPostsById200Response.md +20 -0
- data/docs/GetStorageEnginesById200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetUsersById200Response.md} +2 -2
- 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 +8 -8
- data/docs/JobFunctionsApi.md +38 -25
- data/docs/JobFunctionsInput.md +2 -2
- data/docs/JobFunctionsUpdate.md +2 -2
- data/docs/{CompaniesCompanyIdApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
- data/docs/ListAssetUsecases200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsGet200Response.md → ListAssets200Response.md} +2 -2
- data/docs/{CloudProvidersGet200Response.md → ListCloudProviders200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdAnalyticsAssetsGet200Response.md → ListCompaniesAnalyticsAssets200Response.md} +2 -2
- data/docs/{CompaniesCompanyIdConnectionsGet200Response.md → ListConnections200Response.md} +2 -2
- data/docs/ListEndpoints200Response.md +20 -0
- data/docs/ListIndustries200Response.md +20 -0
- data/docs/{JobFunctionsGet200Response.md → ListJobFunctions200Response.md} +2 -2
- data/docs/ListPostgenIntegrations200Response.md +20 -0
- data/docs/ListPosts200Response.md +20 -0
- data/docs/ListStorageEngines200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersGet200Response.md → ListUsers200Response.md} +2 -2
- 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/{CompaniesCompanyIdApiKeysApiKeyIdPatch200ResponseData.md → UpdateApiKeys200ResponseData.md} +2 -2
- data/docs/UpdateAssetPriceHistory200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200ResponseData.md → UpdateAssetPriceHistory200ResponseData.md} +2 -2
- data/docs/UpdateAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md → UpdateAssets200ResponseData.md} +2 -2
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/{CompaniesCompanyIdPatch200ResponseData.md → UpdateCompanies200ResponseData.md} +2 -2
- 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 +20 -16
- data/docs/UsersApi.md +302 -97
- data/docs/UsersInput.md +14 -10
- data/docs/UsersUpdate.md +14 -10
- 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 +386 -152
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +454 -207
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +949 -225
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +83 -31
- data/lib/spartera_api_sdk/api/companies_api.rb +651 -148
- 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 +75 -23
- 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 +574 -105
- 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/alerts.rb +10 -77
- data/lib/spartera_api_sdk/models/alerts_input.rb +6 -76
- data/lib/spartera_api_sdk/models/alerts_update.rb +6 -76
- data/lib/spartera_api_sdk/models/api_keys.rb +82 -78
- data/lib/spartera_api_sdk/models/api_keys_input.rb +44 -77
- data/lib/spartera_api_sdk/models/api_keys_update.rb +44 -77
- data/lib/spartera_api_sdk/models/asset_price_history.rb +21 -96
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +17 -95
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +17 -78
- data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
- data/lib/spartera_api_sdk/models/assets.rb +262 -93
- data/lib/spartera_api_sdk/models/assets_input.rb +238 -91
- data/lib/spartera_api_sdk/models/assets_update.rb +238 -91
- data/lib/spartera_api_sdk/models/cloud_providers.rb +10 -77
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +6 -76
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +6 -76
- data/lib/spartera_api_sdk/models/companies.rb +72 -81
- data/lib/spartera_api_sdk/models/companies_input.rb +68 -80
- data/lib/spartera_api_sdk/models/companies_update.rb +68 -80
- data/lib/spartera_api_sdk/models/connections.rb +15 -78
- data/lib/spartera_api_sdk/models/connections_input.rb +11 -77
- data/lib/spartera_api_sdk/models/connections_update.rb +11 -77
- data/lib/spartera_api_sdk/models/{cloud_providers_provider_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/create_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_post200_response_data.rb → create_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_patch200_response.rb → create_asset_price_history200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_post200_response_data.rb → create_asset_price_history200_response_data.rb} +5 -78
- 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/{job_functions_function_id_get200_response.rb → create_postgen_integrations200_response.rb} +6 -79
- 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/{companies_company_id_api_keys_api_key_id_delete200_response_data.rb → delete_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data.rb → delete_asset_price_history200_response_data.rb} +5 -78
- 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/favorites.rb +10 -77
- data/lib/spartera_api_sdk/models/favorites_input.rb +6 -76
- data/lib/spartera_api_sdk/models/favorites_update.rb +6 -76
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_api_key_id_get200_response.rb → get_api_keys_by_id200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_get200_response.rb → get_asset_price_history_by_id200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{analyze_company_handle_assets_asset_slug_get200_response.rb → get_assets_by_id_analyze200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_get200_response.rb → get_cloud_providers_by_id200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_get200_response.rb → get_connections_by_id200_response.rb} +5 -78
- 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/{companies_company_id_users_user_id_get200_response.rb → get_users_by_id200_response.rb} +5 -78
- 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/{cloud_providers_provider_id_storage_engines_get200_response.rb → inline_object6.rb} +22 -102
- data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
- data/lib/spartera_api_sdk/models/job_functions.rb +8 -77
- data/lib/spartera_api_sdk/models/job_functions_input.rb +4 -76
- data/lib/spartera_api_sdk/models/job_functions_update.rb +4 -76
- data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{cloud_providers_get200_response.rb → list_asset_usecases200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_get200_response.rb → list_assets200_response.rb} +5 -78
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_get200_response.rb → list_companies_analytics_assets200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{job_functions_get200_response.rb → list_connections200_response.rb} +6 -79
- 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/{companies_company_id_api_keys_api_key_id_patch200_response_data.rb → update_api_keys200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data.rb → update_asset_price_history200_response_data.rb} +5 -78
- 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/{companies_company_id_patch200_response_data.rb → update_companies200_response_data.rb} +5 -78
- 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/users.rb +70 -82
- data/lib/spartera_api_sdk/models/users_input.rb +32 -81
- data/lib/spartera_api_sdk/models/users_update.rb +32 -81
- data/lib/spartera_api_sdk/version.rb +13 -1
- data/lib/spartera_api_sdk.rb +118 -67
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +50 -50
- data/spec/api/api_keys_api_spec.rb +53 -43
- data/spec/api/asset_price_history_api_spec.rb +57 -57
- 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 -48
- 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 +14 -9
- 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 +81 -32
- data/spec/models/alerts_input_spec.rb +3 -3
- data/spec/models/alerts_spec.rb +3 -3
- data/spec/models/alerts_update_spec.rb +3 -3
- data/spec/models/api_keys_input_spec.rb +27 -3
- data/spec/models/api_keys_spec.rb +27 -3
- data/spec/models/api_keys_update_spec.rb +27 -3
- data/spec/models/asset_price_history_input_spec.rb +9 -3
- data/spec/models/asset_price_history_spec.rb +9 -3
- data/spec/models/asset_price_history_update_spec.rb +9 -3
- data/spec/models/asset_usecases_spec.rb +66 -0
- data/spec/models/assets_input_spec.rb +110 -4
- data/spec/models/assets_spec.rb +110 -4
- data/spec/models/assets_update_spec.rb +110 -4
- data/spec/models/cloud_providers_input_spec.rb +3 -3
- data/spec/models/cloud_providers_spec.rb +3 -3
- data/spec/models/cloud_providers_update_spec.rb +3 -3
- data/spec/models/companies_input_spec.rb +19 -3
- data/spec/models/companies_spec.rb +19 -3
- data/spec/models/companies_update_spec.rb +19 -3
- data/spec/models/connections_input_spec.rb +3 -3
- data/spec/models/connections_spec.rb +3 -3
- data/spec/models/connections_update_spec.rb +3 -3
- data/spec/models/create_alerts200_response_data_spec.rb +36 -0
- data/spec/models/create_alerts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_api_keys_post200_response_data_spec.rb → create_api_keys200_response_data_spec.rb} +8 -8
- 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_patch200_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/create_assets_analyze200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_connections_post200_response_data_spec.rb → create_connections200_response_data_spec.rb} +8 -8
- data/spec/models/{cloud_providers_get200_response_spec.rb → create_connections200_response_spec.rb} +8 -8
- 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/{job_functions_function_id_get200_response_spec.rb → create_postgen_integrations200_response_spec.rb} +8 -8
- 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 +3 -3
- data/spec/models/favorites_spec.rb +3 -3
- data/spec/models/favorites_update_spec.rb +3 -3
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/{job_functions_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/{companies_company_id_get200_response_spec.rb → get_cloud_providers_by_id200_response_spec.rb} +8 -8
- 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/{cloud_providers_provider_id_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 +3 -3
- data/spec/models/job_functions_spec.rb +3 -3
- data/spec/models/job_functions_update_spec.rb +3 -3
- 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/postgen_integrations_spec.rb +90 -0
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/posts_input_spec.rb +168 -0
- data/spec/models/posts_spec.rb +186 -0
- data/spec/models/posts_update_spec.rb +168 -0
- data/spec/models/storage_engines_spec.rb +82 -0
- data/spec/models/update_alerts200_response_data_spec.rb +36 -0
- data/spec/models/update_alerts200_response_spec.rb +42 -0
- data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/update_api_keys200_response_spec.rb +42 -0
- data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/update_assets200_response_data_spec.rb +36 -0
- data/spec/models/update_assets200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_patch200_response_data_spec.rb → update_companies200_response_data_spec.rb} +8 -8
- 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 +15 -3
- data/spec/models/users_spec.rb +15 -3
- data/spec/models/users_update_spec.rb +15 -3
- data/spec/spec_helper.rb +111 -0
- metadata +515 -337
- data/docs/CloudProvidersProviderIdStorageEnginesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysApiKeyIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdApiKeysPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPricesPost200Response.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/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/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +0 -20
- data/lib/spartera_api_sdk/models/companies_company_id_analytics_assets_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_api_key_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_post200_response.rb +0 -264
- 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_assets_asset_id_prices_aph_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_prices_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_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_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +0 -266
- 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_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_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_asset_asset_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +0 -266
- 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_category_category_get200_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_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/spec/models/analyze_company_handle_assets_asset_slug_get200_response_spec.rb +0 -42
- data/spec/models/cloud_providers_provider_id_storage_engines_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_analytics_assets_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_api_keys_api_key_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_api_keys_api_key_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_api_keys_post200_response_spec.rb +0 -42
- 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_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_aph_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_prices_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_assets_post200_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_get200_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_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_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_asset_asset_id_get200_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_category_category_get200_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_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/docs/UsersApi.md
CHANGED
|
@@ -4,19 +4,21 @@ All URIs are relative to *https://api.spartera.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
7
|
+
| [**create_users**](UsersApi.md#create_users) | **POST** /companies/{company_id}/users | Create a new user |
|
|
8
|
+
| [**create_users_google_oauth**](UsersApi.md#create_users_google_oauth) | **POST** /companies/{company_id}/users/google-oauth | POST /companies/{company_id}/users/google-oauth |
|
|
9
|
+
| [**create_users_logout**](UsersApi.md#create_users_logout) | **POST** /companies/{company_id}/users/logout | Logout current user by revoking their sessions |
|
|
10
|
+
| [**delete_users**](UsersApi.md#delete_users) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID |
|
|
11
|
+
| [**get_users_by_id**](UsersApi.md#get_users_by_id) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID |
|
|
12
|
+
| [**list_users**](UsersApi.md#list_users) | **GET** /companies/{company_id}/users | Get a list of all users in a company |
|
|
13
|
+
| [**list_users_me**](UsersApi.md#list_users_me) | **GET** /me | Get current authenticated user's profile. |
|
|
14
|
+
| [**update_users**](UsersApi.md#update_users) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID |
|
|
13
15
|
|
|
14
16
|
|
|
15
|
-
##
|
|
17
|
+
## create_users
|
|
16
18
|
|
|
17
|
-
> <
|
|
19
|
+
> <CreateUsers200Response> create_users(company_id, users_input, opts)
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
Create a new user
|
|
20
22
|
|
|
21
23
|
### Examples
|
|
22
24
|
|
|
@@ -32,32 +34,40 @@ SparteraApiSdk.configure do |config|
|
|
|
32
34
|
end
|
|
33
35
|
|
|
34
36
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
35
|
-
company_id = 'company_id_example' # String |
|
|
37
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
38
|
+
users_input = SparteraApiSdk::UsersInput.new({company_id: 'company_id_abc123'}) # UsersInput |
|
|
39
|
+
opts = {
|
|
40
|
+
page: 56, # Integer | Page number for pagination
|
|
41
|
+
limit: 56, # Integer | Number of items per page
|
|
42
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
43
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
44
|
+
search: 'search_example' # String | Search term to filter results
|
|
45
|
+
}
|
|
36
46
|
|
|
37
47
|
begin
|
|
38
|
-
#
|
|
39
|
-
result = api_instance.
|
|
48
|
+
# Create a new user
|
|
49
|
+
result = api_instance.create_users(company_id, users_input, opts)
|
|
40
50
|
p result
|
|
41
51
|
rescue SparteraApiSdk::ApiError => e
|
|
42
|
-
puts "Error when calling UsersApi->
|
|
52
|
+
puts "Error when calling UsersApi->create_users: #{e}"
|
|
43
53
|
end
|
|
44
54
|
```
|
|
45
55
|
|
|
46
|
-
#### Using the
|
|
56
|
+
#### Using the create_users_with_http_info variant
|
|
47
57
|
|
|
48
58
|
This returns an Array which contains the response data, status code and headers.
|
|
49
59
|
|
|
50
|
-
> <Array(<
|
|
60
|
+
> <Array(<CreateUsers200Response>, Integer, Hash)> create_users_with_http_info(company_id, users_input, opts)
|
|
51
61
|
|
|
52
62
|
```ruby
|
|
53
63
|
begin
|
|
54
|
-
#
|
|
55
|
-
data, status_code, headers = api_instance.
|
|
64
|
+
# Create a new user
|
|
65
|
+
data, status_code, headers = api_instance.create_users_with_http_info(company_id, users_input, opts)
|
|
56
66
|
p status_code # => 2xx
|
|
57
67
|
p headers # => { ... }
|
|
58
|
-
p data # => <
|
|
68
|
+
p data # => <CreateUsers200Response>
|
|
59
69
|
rescue SparteraApiSdk::ApiError => e
|
|
60
|
-
puts "Error when calling UsersApi->
|
|
70
|
+
puts "Error when calling UsersApi->create_users_with_http_info: #{e}"
|
|
61
71
|
end
|
|
62
72
|
```
|
|
63
73
|
|
|
@@ -65,11 +75,17 @@ end
|
|
|
65
75
|
|
|
66
76
|
| Name | Type | Description | Notes |
|
|
67
77
|
| ---- | ---- | ----------- | ----- |
|
|
68
|
-
| **company_id** | **String** |
|
|
78
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
79
|
+
| **users_input** | [**UsersInput**](UsersInput.md) | | |
|
|
80
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
81
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
82
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
83
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
84
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
69
85
|
|
|
70
86
|
### Return type
|
|
71
87
|
|
|
72
|
-
[**
|
|
88
|
+
[**CreateUsers200Response**](CreateUsers200Response.md)
|
|
73
89
|
|
|
74
90
|
### Authorization
|
|
75
91
|
|
|
@@ -77,15 +93,15 @@ end
|
|
|
77
93
|
|
|
78
94
|
### HTTP request headers
|
|
79
95
|
|
|
80
|
-
- **Content-Type**:
|
|
96
|
+
- **Content-Type**: application/json
|
|
81
97
|
- **Accept**: application/json
|
|
82
98
|
|
|
83
99
|
|
|
84
|
-
##
|
|
100
|
+
## create_users_google_oauth
|
|
85
101
|
|
|
86
|
-
> <
|
|
102
|
+
> <CreateUsers200Response> create_users_google_oauth(company_id, users_input, opts)
|
|
87
103
|
|
|
88
|
-
|
|
104
|
+
POST /companies/{company_id}/users/google-oauth
|
|
89
105
|
|
|
90
106
|
### Examples
|
|
91
107
|
|
|
@@ -101,33 +117,40 @@ SparteraApiSdk.configure do |config|
|
|
|
101
117
|
end
|
|
102
118
|
|
|
103
119
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
104
|
-
company_id = 'company_id_example' # String |
|
|
105
|
-
users_input = SparteraApiSdk::UsersInput.new({company_id: '
|
|
120
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
121
|
+
users_input = SparteraApiSdk::UsersInput.new({company_id: 'company_id_abc123'}) # UsersInput |
|
|
122
|
+
opts = {
|
|
123
|
+
page: 56, # Integer | Page number for pagination
|
|
124
|
+
limit: 56, # Integer | Number of items per page
|
|
125
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
126
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
127
|
+
search: 'search_example' # String | Search term to filter results
|
|
128
|
+
}
|
|
106
129
|
|
|
107
130
|
begin
|
|
108
|
-
#
|
|
109
|
-
result = api_instance.
|
|
131
|
+
# POST /companies/{company_id}/users/google-oauth
|
|
132
|
+
result = api_instance.create_users_google_oauth(company_id, users_input, opts)
|
|
110
133
|
p result
|
|
111
134
|
rescue SparteraApiSdk::ApiError => e
|
|
112
|
-
puts "Error when calling UsersApi->
|
|
135
|
+
puts "Error when calling UsersApi->create_users_google_oauth: #{e}"
|
|
113
136
|
end
|
|
114
137
|
```
|
|
115
138
|
|
|
116
|
-
#### Using the
|
|
139
|
+
#### Using the create_users_google_oauth_with_http_info variant
|
|
117
140
|
|
|
118
141
|
This returns an Array which contains the response data, status code and headers.
|
|
119
142
|
|
|
120
|
-
> <Array(<
|
|
143
|
+
> <Array(<CreateUsers200Response>, Integer, Hash)> create_users_google_oauth_with_http_info(company_id, users_input, opts)
|
|
121
144
|
|
|
122
145
|
```ruby
|
|
123
146
|
begin
|
|
124
|
-
#
|
|
125
|
-
data, status_code, headers = api_instance.
|
|
147
|
+
# POST /companies/{company_id}/users/google-oauth
|
|
148
|
+
data, status_code, headers = api_instance.create_users_google_oauth_with_http_info(company_id, users_input, opts)
|
|
126
149
|
p status_code # => 2xx
|
|
127
150
|
p headers # => { ... }
|
|
128
|
-
p data # => <
|
|
151
|
+
p data # => <CreateUsers200Response>
|
|
129
152
|
rescue SparteraApiSdk::ApiError => e
|
|
130
|
-
puts "Error when calling UsersApi->
|
|
153
|
+
puts "Error when calling UsersApi->create_users_google_oauth_with_http_info: #{e}"
|
|
131
154
|
end
|
|
132
155
|
```
|
|
133
156
|
|
|
@@ -135,12 +158,17 @@ end
|
|
|
135
158
|
|
|
136
159
|
| Name | Type | Description | Notes |
|
|
137
160
|
| ---- | ---- | ----------- | ----- |
|
|
138
|
-
| **company_id** | **String** |
|
|
161
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
139
162
|
| **users_input** | [**UsersInput**](UsersInput.md) | | |
|
|
163
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
164
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
165
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
166
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
167
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
140
168
|
|
|
141
169
|
### Return type
|
|
142
170
|
|
|
143
|
-
[**
|
|
171
|
+
[**CreateUsers200Response**](CreateUsers200Response.md)
|
|
144
172
|
|
|
145
173
|
### Authorization
|
|
146
174
|
|
|
@@ -152,9 +180,92 @@ end
|
|
|
152
180
|
- **Accept**: application/json
|
|
153
181
|
|
|
154
182
|
|
|
155
|
-
##
|
|
183
|
+
## create_users_logout
|
|
184
|
+
|
|
185
|
+
> <CreateUsers200Response> create_users_logout(company_id, users_input, opts)
|
|
186
|
+
|
|
187
|
+
Logout current user by revoking their sessions
|
|
188
|
+
|
|
189
|
+
### Examples
|
|
190
|
+
|
|
191
|
+
```ruby
|
|
192
|
+
require 'time'
|
|
193
|
+
require 'spartera_api_sdk'
|
|
194
|
+
# setup authorization
|
|
195
|
+
SparteraApiSdk.configure do |config|
|
|
196
|
+
# Configure API key authorization: ApiKeyAuth
|
|
197
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
199
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
api_instance = SparteraApiSdk::UsersApi.new
|
|
203
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
204
|
+
users_input = SparteraApiSdk::UsersInput.new({company_id: 'company_id_abc123'}) # UsersInput |
|
|
205
|
+
opts = {
|
|
206
|
+
page: 56, # Integer | Page number for pagination
|
|
207
|
+
limit: 56, # Integer | Number of items per page
|
|
208
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
209
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
210
|
+
search: 'search_example' # String | Search term to filter results
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
begin
|
|
214
|
+
# Logout current user by revoking their sessions
|
|
215
|
+
result = api_instance.create_users_logout(company_id, users_input, opts)
|
|
216
|
+
p result
|
|
217
|
+
rescue SparteraApiSdk::ApiError => e
|
|
218
|
+
puts "Error when calling UsersApi->create_users_logout: #{e}"
|
|
219
|
+
end
|
|
220
|
+
```
|
|
156
221
|
|
|
157
|
-
|
|
222
|
+
#### Using the create_users_logout_with_http_info variant
|
|
223
|
+
|
|
224
|
+
This returns an Array which contains the response data, status code and headers.
|
|
225
|
+
|
|
226
|
+
> <Array(<CreateUsers200Response>, Integer, Hash)> create_users_logout_with_http_info(company_id, users_input, opts)
|
|
227
|
+
|
|
228
|
+
```ruby
|
|
229
|
+
begin
|
|
230
|
+
# Logout current user by revoking their sessions
|
|
231
|
+
data, status_code, headers = api_instance.create_users_logout_with_http_info(company_id, users_input, opts)
|
|
232
|
+
p status_code # => 2xx
|
|
233
|
+
p headers # => { ... }
|
|
234
|
+
p data # => <CreateUsers200Response>
|
|
235
|
+
rescue SparteraApiSdk::ApiError => e
|
|
236
|
+
puts "Error when calling UsersApi->create_users_logout_with_http_info: #{e}"
|
|
237
|
+
end
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Parameters
|
|
241
|
+
|
|
242
|
+
| Name | Type | Description | Notes |
|
|
243
|
+
| ---- | ---- | ----------- | ----- |
|
|
244
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
245
|
+
| **users_input** | [**UsersInput**](UsersInput.md) | | |
|
|
246
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
247
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
248
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
249
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
250
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
[**CreateUsers200Response**](CreateUsers200Response.md)
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: application/json
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
## delete_users
|
|
267
|
+
|
|
268
|
+
> <DeleteUsers200Response> delete_users(company_id, user_id)
|
|
158
269
|
|
|
159
270
|
Delete single user by ID
|
|
160
271
|
|
|
@@ -172,33 +283,33 @@ SparteraApiSdk.configure do |config|
|
|
|
172
283
|
end
|
|
173
284
|
|
|
174
285
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
175
|
-
company_id = 'company_id_example' # String |
|
|
176
|
-
user_id = 'user_id_example' # String |
|
|
286
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
287
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
177
288
|
|
|
178
289
|
begin
|
|
179
290
|
# Delete single user by ID
|
|
180
|
-
result = api_instance.
|
|
291
|
+
result = api_instance.delete_users(company_id, user_id)
|
|
181
292
|
p result
|
|
182
293
|
rescue SparteraApiSdk::ApiError => e
|
|
183
|
-
puts "Error when calling UsersApi->
|
|
294
|
+
puts "Error when calling UsersApi->delete_users: #{e}"
|
|
184
295
|
end
|
|
185
296
|
```
|
|
186
297
|
|
|
187
|
-
#### Using the
|
|
298
|
+
#### Using the delete_users_with_http_info variant
|
|
188
299
|
|
|
189
300
|
This returns an Array which contains the response data, status code and headers.
|
|
190
301
|
|
|
191
|
-
> <Array(<
|
|
302
|
+
> <Array(<DeleteUsers200Response>, Integer, Hash)> delete_users_with_http_info(company_id, user_id)
|
|
192
303
|
|
|
193
304
|
```ruby
|
|
194
305
|
begin
|
|
195
306
|
# Delete single user by ID
|
|
196
|
-
data, status_code, headers = api_instance.
|
|
307
|
+
data, status_code, headers = api_instance.delete_users_with_http_info(company_id, user_id)
|
|
197
308
|
p status_code # => 2xx
|
|
198
309
|
p headers # => { ... }
|
|
199
|
-
p data # => <
|
|
310
|
+
p data # => <DeleteUsers200Response>
|
|
200
311
|
rescue SparteraApiSdk::ApiError => e
|
|
201
|
-
puts "Error when calling UsersApi->
|
|
312
|
+
puts "Error when calling UsersApi->delete_users_with_http_info: #{e}"
|
|
202
313
|
end
|
|
203
314
|
```
|
|
204
315
|
|
|
@@ -206,12 +317,12 @@ end
|
|
|
206
317
|
|
|
207
318
|
| Name | Type | Description | Notes |
|
|
208
319
|
| ---- | ---- | ----------- | ----- |
|
|
209
|
-
| **company_id** | **String** |
|
|
210
|
-
| **user_id** | **String** |
|
|
320
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
321
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
211
322
|
|
|
212
323
|
### Return type
|
|
213
324
|
|
|
214
|
-
[**
|
|
325
|
+
[**DeleteUsers200Response**](DeleteUsers200Response.md)
|
|
215
326
|
|
|
216
327
|
### Authorization
|
|
217
328
|
|
|
@@ -223,9 +334,9 @@ end
|
|
|
223
334
|
- **Accept**: application/json
|
|
224
335
|
|
|
225
336
|
|
|
226
|
-
##
|
|
337
|
+
## get_users_by_id
|
|
227
338
|
|
|
228
|
-
> <
|
|
339
|
+
> <GetUsersById200Response> get_users_by_id(company_id, user_id)
|
|
229
340
|
|
|
230
341
|
Get single user by ID
|
|
231
342
|
|
|
@@ -243,33 +354,33 @@ SparteraApiSdk.configure do |config|
|
|
|
243
354
|
end
|
|
244
355
|
|
|
245
356
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
246
|
-
company_id = 'company_id_example' # String |
|
|
247
|
-
user_id = 'user_id_example' # String |
|
|
357
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
358
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
248
359
|
|
|
249
360
|
begin
|
|
250
361
|
# Get single user by ID
|
|
251
|
-
result = api_instance.
|
|
362
|
+
result = api_instance.get_users_by_id(company_id, user_id)
|
|
252
363
|
p result
|
|
253
364
|
rescue SparteraApiSdk::ApiError => e
|
|
254
|
-
puts "Error when calling UsersApi->
|
|
365
|
+
puts "Error when calling UsersApi->get_users_by_id: #{e}"
|
|
255
366
|
end
|
|
256
367
|
```
|
|
257
368
|
|
|
258
|
-
#### Using the
|
|
369
|
+
#### Using the get_users_by_id_with_http_info variant
|
|
259
370
|
|
|
260
371
|
This returns an Array which contains the response data, status code and headers.
|
|
261
372
|
|
|
262
|
-
> <Array(<
|
|
373
|
+
> <Array(<GetUsersById200Response>, Integer, Hash)> get_users_by_id_with_http_info(company_id, user_id)
|
|
263
374
|
|
|
264
375
|
```ruby
|
|
265
376
|
begin
|
|
266
377
|
# Get single user by ID
|
|
267
|
-
data, status_code, headers = api_instance.
|
|
378
|
+
data, status_code, headers = api_instance.get_users_by_id_with_http_info(company_id, user_id)
|
|
268
379
|
p status_code # => 2xx
|
|
269
380
|
p headers # => { ... }
|
|
270
|
-
p data # => <
|
|
381
|
+
p data # => <GetUsersById200Response>
|
|
271
382
|
rescue SparteraApiSdk::ApiError => e
|
|
272
|
-
puts "Error when calling UsersApi->
|
|
383
|
+
puts "Error when calling UsersApi->get_users_by_id_with_http_info: #{e}"
|
|
273
384
|
end
|
|
274
385
|
```
|
|
275
386
|
|
|
@@ -277,12 +388,12 @@ end
|
|
|
277
388
|
|
|
278
389
|
| Name | Type | Description | Notes |
|
|
279
390
|
| ---- | ---- | ----------- | ----- |
|
|
280
|
-
| **company_id** | **String** |
|
|
281
|
-
| **user_id** | **String** |
|
|
391
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
392
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
282
393
|
|
|
283
394
|
### Return type
|
|
284
395
|
|
|
285
|
-
[**
|
|
396
|
+
[**GetUsersById200Response**](GetUsersById200Response.md)
|
|
286
397
|
|
|
287
398
|
### Authorization
|
|
288
399
|
|
|
@@ -294,11 +405,11 @@ end
|
|
|
294
405
|
- **Accept**: application/json
|
|
295
406
|
|
|
296
407
|
|
|
297
|
-
##
|
|
408
|
+
## list_users
|
|
298
409
|
|
|
299
|
-
> <
|
|
410
|
+
> <ListUsers200Response> list_users(company_id, opts)
|
|
300
411
|
|
|
301
|
-
|
|
412
|
+
Get a list of all users in a company
|
|
302
413
|
|
|
303
414
|
### Examples
|
|
304
415
|
|
|
@@ -314,34 +425,39 @@ SparteraApiSdk.configure do |config|
|
|
|
314
425
|
end
|
|
315
426
|
|
|
316
427
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
317
|
-
company_id = 'company_id_example' # String |
|
|
318
|
-
|
|
319
|
-
|
|
428
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
429
|
+
opts = {
|
|
430
|
+
page: 56, # Integer | Page number for pagination
|
|
431
|
+
limit: 56, # Integer | Number of items per page
|
|
432
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
433
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
434
|
+
search: 'search_example' # String | Search term to filter results
|
|
435
|
+
}
|
|
320
436
|
|
|
321
437
|
begin
|
|
322
|
-
#
|
|
323
|
-
result = api_instance.
|
|
438
|
+
# Get a list of all users in a company
|
|
439
|
+
result = api_instance.list_users(company_id, opts)
|
|
324
440
|
p result
|
|
325
441
|
rescue SparteraApiSdk::ApiError => e
|
|
326
|
-
puts "Error when calling UsersApi->
|
|
442
|
+
puts "Error when calling UsersApi->list_users: #{e}"
|
|
327
443
|
end
|
|
328
444
|
```
|
|
329
445
|
|
|
330
|
-
#### Using the
|
|
446
|
+
#### Using the list_users_with_http_info variant
|
|
331
447
|
|
|
332
448
|
This returns an Array which contains the response data, status code and headers.
|
|
333
449
|
|
|
334
|
-
> <Array(<
|
|
450
|
+
> <Array(<ListUsers200Response>, Integer, Hash)> list_users_with_http_info(company_id, opts)
|
|
335
451
|
|
|
336
452
|
```ruby
|
|
337
453
|
begin
|
|
338
|
-
#
|
|
339
|
-
data, status_code, headers = api_instance.
|
|
454
|
+
# Get a list of all users in a company
|
|
455
|
+
data, status_code, headers = api_instance.list_users_with_http_info(company_id, opts)
|
|
340
456
|
p status_code # => 2xx
|
|
341
457
|
p headers # => { ... }
|
|
342
|
-
p data # => <
|
|
458
|
+
p data # => <ListUsers200Response>
|
|
343
459
|
rescue SparteraApiSdk::ApiError => e
|
|
344
|
-
puts "Error when calling UsersApi->
|
|
460
|
+
puts "Error when calling UsersApi->list_users_with_http_info: #{e}"
|
|
345
461
|
end
|
|
346
462
|
```
|
|
347
463
|
|
|
@@ -349,13 +465,16 @@ end
|
|
|
349
465
|
|
|
350
466
|
| Name | Type | Description | Notes |
|
|
351
467
|
| ---- | ---- | ----------- | ----- |
|
|
352
|
-
| **company_id** | **String** |
|
|
353
|
-
| **
|
|
354
|
-
| **
|
|
468
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
469
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
470
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
471
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
472
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
473
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
355
474
|
|
|
356
475
|
### Return type
|
|
357
476
|
|
|
358
|
-
[**
|
|
477
|
+
[**ListUsers200Response**](ListUsers200Response.md)
|
|
359
478
|
|
|
360
479
|
### Authorization
|
|
361
480
|
|
|
@@ -363,13 +482,13 @@ end
|
|
|
363
482
|
|
|
364
483
|
### HTTP request headers
|
|
365
484
|
|
|
366
|
-
- **Content-Type**:
|
|
485
|
+
- **Content-Type**: Not defined
|
|
367
486
|
- **Accept**: application/json
|
|
368
487
|
|
|
369
488
|
|
|
370
|
-
##
|
|
489
|
+
## list_users_me
|
|
371
490
|
|
|
372
|
-
> <
|
|
491
|
+
> <ListUsers200Response> list_users_me(opts)
|
|
373
492
|
|
|
374
493
|
Get current authenticated user's profile.
|
|
375
494
|
|
|
@@ -387,41 +506,54 @@ SparteraApiSdk.configure do |config|
|
|
|
387
506
|
end
|
|
388
507
|
|
|
389
508
|
api_instance = SparteraApiSdk::UsersApi.new
|
|
509
|
+
opts = {
|
|
510
|
+
page: 56, # Integer | Page number for pagination
|
|
511
|
+
limit: 56, # Integer | Number of items per page
|
|
512
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
513
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
514
|
+
search: 'search_example' # String | Search term to filter results
|
|
515
|
+
}
|
|
390
516
|
|
|
391
517
|
begin
|
|
392
518
|
# Get current authenticated user's profile.
|
|
393
|
-
result = api_instance.
|
|
519
|
+
result = api_instance.list_users_me(opts)
|
|
394
520
|
p result
|
|
395
521
|
rescue SparteraApiSdk::ApiError => e
|
|
396
|
-
puts "Error when calling UsersApi->
|
|
522
|
+
puts "Error when calling UsersApi->list_users_me: #{e}"
|
|
397
523
|
end
|
|
398
524
|
```
|
|
399
525
|
|
|
400
|
-
#### Using the
|
|
526
|
+
#### Using the list_users_me_with_http_info variant
|
|
401
527
|
|
|
402
528
|
This returns an Array which contains the response data, status code and headers.
|
|
403
529
|
|
|
404
|
-
> <Array(<
|
|
530
|
+
> <Array(<ListUsers200Response>, Integer, Hash)> list_users_me_with_http_info(opts)
|
|
405
531
|
|
|
406
532
|
```ruby
|
|
407
533
|
begin
|
|
408
534
|
# Get current authenticated user's profile.
|
|
409
|
-
data, status_code, headers = api_instance.
|
|
535
|
+
data, status_code, headers = api_instance.list_users_me_with_http_info(opts)
|
|
410
536
|
p status_code # => 2xx
|
|
411
537
|
p headers # => { ... }
|
|
412
|
-
p data # => <
|
|
538
|
+
p data # => <ListUsers200Response>
|
|
413
539
|
rescue SparteraApiSdk::ApiError => e
|
|
414
|
-
puts "Error when calling UsersApi->
|
|
540
|
+
puts "Error when calling UsersApi->list_users_me_with_http_info: #{e}"
|
|
415
541
|
end
|
|
416
542
|
```
|
|
417
543
|
|
|
418
544
|
### Parameters
|
|
419
545
|
|
|
420
|
-
|
|
546
|
+
| Name | Type | Description | Notes |
|
|
547
|
+
| ---- | ---- | ----------- | ----- |
|
|
548
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
549
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
550
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
551
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
552
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
421
553
|
|
|
422
554
|
### Return type
|
|
423
555
|
|
|
424
|
-
[**
|
|
556
|
+
[**ListUsers200Response**](ListUsers200Response.md)
|
|
425
557
|
|
|
426
558
|
### Authorization
|
|
427
559
|
|
|
@@ -432,3 +564,76 @@ This endpoint does not need any parameter.
|
|
|
432
564
|
- **Content-Type**: Not defined
|
|
433
565
|
- **Accept**: application/json
|
|
434
566
|
|
|
567
|
+
|
|
568
|
+
## update_users
|
|
569
|
+
|
|
570
|
+
> <UpdateUsers200Response> update_users(company_id, user_id, users_update)
|
|
571
|
+
|
|
572
|
+
Update an existing user by ID
|
|
573
|
+
|
|
574
|
+
### Examples
|
|
575
|
+
|
|
576
|
+
```ruby
|
|
577
|
+
require 'time'
|
|
578
|
+
require 'spartera_api_sdk'
|
|
579
|
+
# setup authorization
|
|
580
|
+
SparteraApiSdk.configure do |config|
|
|
581
|
+
# Configure API key authorization: ApiKeyAuth
|
|
582
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
583
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
584
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
api_instance = SparteraApiSdk::UsersApi.new
|
|
588
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
589
|
+
user_id = 'user_id_example' # String | Unique identifier for the User
|
|
590
|
+
users_update = SparteraApiSdk::UsersUpdate.new # UsersUpdate |
|
|
591
|
+
|
|
592
|
+
begin
|
|
593
|
+
# Update an existing user by ID
|
|
594
|
+
result = api_instance.update_users(company_id, user_id, users_update)
|
|
595
|
+
p result
|
|
596
|
+
rescue SparteraApiSdk::ApiError => e
|
|
597
|
+
puts "Error when calling UsersApi->update_users: #{e}"
|
|
598
|
+
end
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
#### Using the update_users_with_http_info variant
|
|
602
|
+
|
|
603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
604
|
+
|
|
605
|
+
> <Array(<UpdateUsers200Response>, Integer, Hash)> update_users_with_http_info(company_id, user_id, users_update)
|
|
606
|
+
|
|
607
|
+
```ruby
|
|
608
|
+
begin
|
|
609
|
+
# Update an existing user by ID
|
|
610
|
+
data, status_code, headers = api_instance.update_users_with_http_info(company_id, user_id, users_update)
|
|
611
|
+
p status_code # => 2xx
|
|
612
|
+
p headers # => { ... }
|
|
613
|
+
p data # => <UpdateUsers200Response>
|
|
614
|
+
rescue SparteraApiSdk::ApiError => e
|
|
615
|
+
puts "Error when calling UsersApi->update_users_with_http_info: #{e}"
|
|
616
|
+
end
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### Parameters
|
|
620
|
+
|
|
621
|
+
| Name | Type | Description | Notes |
|
|
622
|
+
| ---- | ---- | ----------- | ----- |
|
|
623
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
624
|
+
| **user_id** | **String** | Unique identifier for the User | |
|
|
625
|
+
| **users_update** | [**UsersUpdate**](UsersUpdate.md) | | |
|
|
626
|
+
|
|
627
|
+
### Return type
|
|
628
|
+
|
|
629
|
+
[**UpdateUsers200Response**](UpdateUsers200Response.md)
|
|
630
|
+
|
|
631
|
+
### Authorization
|
|
632
|
+
|
|
633
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
634
|
+
|
|
635
|
+
### HTTP request headers
|
|
636
|
+
|
|
637
|
+
- **Content-Type**: application/json
|
|
638
|
+
- **Accept**: application/json
|
|
639
|
+
|