spartera_api_sdk 1.0.74 → 1.0.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/Gemfile +9 -0
- data/README.md +333 -324
- data/Rakefile +10 -0
- data/docs/APIKeysApi.md +261 -87
- data/docs/Alerts.md +30 -0
- data/docs/AlertsApi.md +139 -139
- data/docs/AlertsInput.md +24 -0
- data/docs/AlertsUpdate.md +24 -0
- data/docs/ApiKeys.md +40 -0
- data/docs/ApiKeysInput.md +34 -0
- data/docs/ApiKeysUpdate.md +34 -0
- data/docs/AssetPriceHistory.md +30 -0
- data/docs/AssetPriceHistoryApi.md +162 -154
- data/docs/AssetPriceHistoryInput.md +24 -0
- data/docs/AssetPriceHistoryUpdate.md +24 -0
- data/docs/AssetUsecases.md +28 -0
- data/docs/AssetUsecasesApi.md +157 -0
- data/docs/Assets.md +138 -0
- data/docs/AssetsApi.md +534 -206
- data/docs/AssetsInput.md +124 -0
- data/docs/AssetsUpdate.md +124 -0
- data/docs/CloudProviders.md +28 -0
- data/docs/CloudProvidersApi.md +44 -31
- data/docs/CloudProvidersInput.md +22 -0
- data/docs/CloudProvidersUpdate.md +22 -0
- data/docs/Companies.md +46 -0
- data/docs/CompaniesApi.md +312 -144
- data/docs/CompaniesInput.md +40 -0
- data/docs/CompaniesUpdate.md +40 -0
- data/docs/Connections.md +38 -0
- data/docs/ConnectionsApi.md +149 -125
- data/docs/ConnectionsInput.md +32 -0
- data/docs/ConnectionsUpdate.md +32 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdGet200Response.md → CreateAlerts200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md → CreateAlerts200ResponseData.md} +2 -2
- data/docs/CreateApiKeys200Response.md +20 -0
- data/docs/CreateApiKeys200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → CreateAssetPriceHistory200Response.md} +3 -3
- data/docs/CreateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/CreateAssetsAnalyze200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsPost200ResponseData.md → CreateAssetsAnalyze200ResponseData.md} +2 -2
- data/docs/CreateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsPost200ResponseData.md → CreateConnections200ResponseData.md} +2 -2
- data/docs/CreateEndpoints200Response.md +20 -0
- data/docs/CreateEndpoints200ResponseData.md +18 -0
- data/docs/CreateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md → CreateFavorites200ResponseData.md} +2 -2
- data/docs/CreatePostgenIntegrations200Response.md +20 -0
- data/docs/CreatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/{CompaniesCompanyIdAssetsGet200Response.md → CreatePosts200Response.md} +3 -3
- data/docs/CreatePosts200ResponseData.md +18 -0
- data/docs/CreateUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersPost200ResponseData.md → CreateUsers200ResponseData.md} +2 -2
- data/docs/DeleteAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md → DeleteAlerts200ResponseData.md} +2 -2
- data/docs/DeleteApiKeys200Response.md +20 -0
- data/docs/DeleteApiKeys200ResponseData.md +18 -0
- data/docs/DeleteAssetPriceHistory200Response.md +20 -0
- data/docs/DeleteAssetPriceHistory200ResponseData.md +18 -0
- data/docs/DeleteAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md → DeleteAssets200ResponseData.md} +2 -2
- data/docs/DeleteConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md → DeleteConnections200ResponseData.md} +2 -2
- data/docs/DeleteEndpoints200Response.md +20 -0
- data/docs/DeleteEndpoints200ResponseData.md +18 -0
- data/docs/DeleteFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md → DeleteFavorites200ResponseData.md} +2 -2
- data/docs/DeletePostgenIntegrations200Response.md +20 -0
- data/docs/DeletePostgenIntegrations200ResponseData.md +18 -0
- data/docs/DeletePosts200Response.md +20 -0
- data/docs/DeletePosts200ResponseData.md +18 -0
- data/docs/DeleteUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdDelete200ResponseData.md → DeleteUsers200ResponseData.md} +2 -2
- data/docs/Endpoints.md +80 -0
- data/docs/EndpointsApi.md +1043 -0
- data/docs/EndpointsInput.md +78 -0
- data/docs/EndpointsUpdate.md +78 -0
- data/docs/Favorites.md +34 -0
- data/docs/FavoritesApi.md +159 -159
- data/docs/FavoritesInput.md +28 -0
- data/docs/FavoritesUpdate.md +28 -0
- data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetAlertsById200Response.md} +3 -3
- data/docs/{CompaniesCompanyIdUsersGet200Response.md → GetApiKeysById200Response.md} +3 -3
- data/docs/GetAssetPriceHistoryById200Response.md +20 -0
- data/docs/GetAssetUsecasesById200Response.md +20 -0
- data/docs/GetAssetsByIdAnalyze200Response.md +20 -0
- data/docs/GetCloudProvidersById200Response.md +20 -0
- data/docs/GetCompaniesById200Response.md +20 -0
- data/docs/GetConnectionsById200Response.md +20 -0
- data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
- data/docs/GetFavoritesById200Response.md +20 -0
- data/docs/GetIndustriesById200Response.md +20 -0
- data/docs/GetJobFunctionsById200Response.md +20 -0
- data/docs/GetPostgenIntegrationsById200Response.md +20 -0
- data/docs/GetPostsById200Response.md +20 -0
- data/docs/GetStorageEnginesById200Response.md +20 -0
- data/docs/GetUsersById200Response.md +20 -0
- data/docs/Industries.md +32 -0
- data/docs/IndustriesApi.md +237 -0
- data/docs/InlineObject4.md +20 -0
- data/docs/InlineObject5.md +20 -0
- data/docs/InlineObject6.md +22 -0
- data/docs/InlineObject7.md +20 -0
- data/docs/JobFunctions.md +24 -0
- data/docs/JobFunctionsApi.md +157 -0
- data/docs/JobFunctionsInput.md +18 -0
- data/docs/JobFunctionsUpdate.md +18 -0
- data/docs/ListApiKeys200Response.md +20 -0
- data/docs/ListAssetUsecases200Response.md +20 -0
- data/docs/ListAssets200Response.md +20 -0
- data/docs/ListCloudProviders200Response.md +20 -0
- data/docs/{CompaniesCompanyIdApiKeysGet200Response.md → ListCompaniesAnalyticsAssets200Response.md} +3 -3
- data/docs/ListConnections200Response.md +20 -0
- data/docs/ListEndpoints200Response.md +20 -0
- data/docs/ListIndustries200Response.md +20 -0
- data/docs/ListJobFunctions200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsGet200Response.md → ListPostgenIntegrations200Response.md} +3 -3
- data/docs/ListPosts200Response.md +20 -0
- data/docs/ListStorageEngines200Response.md +20 -0
- data/docs/ListUsers200Response.md +20 -0
- data/docs/PostPublications.md +40 -0
- data/docs/PostPublicationsInput.md +34 -0
- data/docs/PostPublicationsUpdate.md +34 -0
- data/docs/PostgenIntegrations.md +36 -0
- data/docs/PostgenIntegrationsApi.md +463 -0
- data/docs/PostgenIntegrationsInput.md +30 -0
- data/docs/PostgenIntegrationsUpdate.md +30 -0
- data/docs/Posts.md +68 -0
- data/docs/PostsApi.md +843 -0
- data/docs/PostsInput.md +62 -0
- data/docs/PostsUpdate.md +62 -0
- data/docs/StorageEngines.md +32 -0
- data/docs/StorageEnginesApi.md +40 -28
- data/docs/UpdateAlerts200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md → UpdateAlerts200ResponseData.md} +2 -2
- data/docs/UpdateApiKeys200Response.md +20 -0
- data/docs/UpdateApiKeys200ResponseData.md +18 -0
- data/docs/UpdateAssetPriceHistory200Response.md +20 -0
- data/docs/UpdateAssetPriceHistory200ResponseData.md +18 -0
- data/docs/UpdateAssets200Response.md +20 -0
- data/docs/{CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md → UpdateAssets200ResponseData.md} +2 -2
- data/docs/UpdateCompanies200Response.md +20 -0
- data/docs/UpdateCompanies200ResponseData.md +18 -0
- data/docs/UpdateConnections200Response.md +20 -0
- data/docs/{CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md → UpdateConnections200ResponseData.md} +2 -2
- data/docs/UpdateEndpoints200Response.md +20 -0
- data/docs/UpdateEndpoints200ResponseData.md +18 -0
- data/docs/UpdateFavorites200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md → UpdateFavorites200ResponseData.md} +2 -2
- data/docs/UpdatePostgenIntegrations200Response.md +20 -0
- data/docs/UpdatePostgenIntegrations200ResponseData.md +18 -0
- data/docs/UpdatePosts200Response.md +20 -0
- data/docs/UpdatePosts200ResponseData.md +18 -0
- data/docs/UpdateUsers200Response.md +20 -0
- data/docs/{CompaniesCompanyIdUsersUserIdPatch200ResponseData.md → UpdateUsers200ResponseData.md} +2 -2
- data/docs/Users.md +36 -0
- data/docs/UsersApi.md +306 -101
- data/docs/UsersInput.md +30 -0
- data/docs/UsersUpdate.md +30 -0
- data/git_push.sh +57 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +414 -167
- data/lib/spartera_api_sdk/api/api_keys_api.rb +491 -90
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +460 -169
- data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +952 -228
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +83 -31
- data/lib/spartera_api_sdk/api/companies_api.rb +651 -137
- data/lib/spartera_api_sdk/api/connections_api.rb +376 -142
- data/lib/spartera_api_sdk/api/endpoints_api.rb +1416 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +456 -196
- data/lib/spartera_api_sdk/api/industries_api.rb +284 -0
- data/lib/spartera_api_sdk/api/job_functions_api.rb +190 -0
- data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +634 -0
- data/lib/spartera_api_sdk/api/posts_api.rb +1190 -0
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +107 -29
- data/lib/spartera_api_sdk/api/users_api.rb +581 -112
- data/lib/spartera_api_sdk/api_client.rb +8 -4
- data/lib/spartera_api_sdk/api_error.rb +2 -2
- data/lib/spartera_api_sdk/api_model_base.rb +88 -0
- data/lib/spartera_api_sdk/configuration.rb +2 -2
- data/lib/spartera_api_sdk/models/{alert.rb → alerts.rb} +46 -139
- data/lib/spartera_api_sdk/models/alerts_input.rb +213 -0
- data/lib/spartera_api_sdk/models/alerts_update.rb +179 -0
- data/lib/spartera_api_sdk/models/{apikey.rb → api_keys.rb} +98 -124
- data/lib/spartera_api_sdk/models/api_keys_input.rb +263 -0
- data/lib/spartera_api_sdk/models/api_keys_update.rb +229 -0
- data/lib/spartera_api_sdk/models/asset_price_history.rb +209 -0
- data/lib/spartera_api_sdk/models/asset_price_history_input.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_price_history_update.rb +179 -0
- data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
- data/lib/spartera_api_sdk/models/assets.rb +1048 -0
- data/lib/spartera_api_sdk/models/assets_input.rb +898 -0
- data/lib/spartera_api_sdk/models/assets_update.rb +857 -0
- data/lib/spartera_api_sdk/models/{cloudprovider.rb → cloud_providers.rb} +35 -111
- data/lib/spartera_api_sdk/models/cloud_providers_input.rb +186 -0
- data/lib/spartera_api_sdk/models/cloud_providers_update.rb +169 -0
- data/lib/spartera_api_sdk/models/{company.rb → companies.rb} +90 -105
- data/lib/spartera_api_sdk/models/companies_input.rb +327 -0
- data/lib/spartera_api_sdk/models/companies_update.rb +293 -0
- data/lib/spartera_api_sdk/models/{connection.rb → connections.rb} +69 -186
- data/lib/spartera_api_sdk/models/connections_input.rb +287 -0
- data/lib/spartera_api_sdk/models/connections_update.rb +253 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_get200_response.rb → create_alerts200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_post200_response_data.rb → create_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_get200_response.rb → create_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{me_get200_response_api_key_info.rb → create_api_keys200_response_data.rb} +27 -94
- data/lib/spartera_api_sdk/models/{companies_company_id_users_post200_response.rb → create_asset_price_history200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_post200_response_data.rb → create_assets_analyze200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_post200_response_data.rb → create_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_post200_response_data.rb → create_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/create_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_post200_response_data.rb → create_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb → delete_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_delete200_response_data.rb → delete_assets200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_delete200_response_data.rb → delete_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb → delete_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/delete_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_delete200_response_data.rb → delete_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/endpoints.rb +684 -0
- data/lib/spartera_api_sdk/models/endpoints_input.rb +582 -0
- data/lib/spartera_api_sdk/models/endpoints_update.rb +531 -0
- data/lib/spartera_api_sdk/models/error.rb +3 -76
- data/lib/spartera_api_sdk/models/{favorite.rb → favorites.rb} +38 -111
- data/lib/spartera_api_sdk/models/favorites_input.rb +233 -0
- data/lib/spartera_api_sdk/models/favorites_update.rb +199 -0
- data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_delete200_response.rb → get_endpoints_by_id_connections_describe200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_get200_response.rb → get_postgen_integrations_by_id200_response.rb} +7 -82
- data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/industries.rb +253 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object1.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object2.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object3.rb +3 -76
- data/lib/spartera_api_sdk/models/inline_object4.rb +156 -0
- data/lib/spartera_api_sdk/models/inline_object5.rb +156 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_api_keys_get200_response.rb → inline_object6.rb} +22 -104
- data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
- data/lib/spartera_api_sdk/models/job_functions.rb +213 -0
- data/lib/spartera_api_sdk/models/job_functions_input.rb +166 -0
- data/lib/spartera_api_sdk/models/job_functions_update.rb +149 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_get200_response.rb → list_api_keys200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_get200_response.rb → list_asset_usecases200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_get200_response.rb → list_assets200_response.rb} +6 -79
- data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_post200_response.rb → list_companies_analytics_assets200_response.rb} +9 -80
- data/lib/spartera_api_sdk/models/list_connections200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_industries200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_posts200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/list_users200_response.rb +193 -0
- data/lib/spartera_api_sdk/models/post_publications.rb +327 -0
- data/lib/spartera_api_sdk/models/post_publications_input.rb +280 -0
- data/lib/spartera_api_sdk/models/post_publications_update.rb +229 -0
- data/lib/spartera_api_sdk/models/postgen_integrations.rb +341 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +294 -0
- data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +209 -0
- data/lib/spartera_api_sdk/models/posts.rb +586 -0
- data/lib/spartera_api_sdk/models/posts_input.rb +437 -0
- data/lib/spartera_api_sdk/models/posts_update.rb +369 -0
- data/lib/spartera_api_sdk/models/storage_engines.rb +294 -0
- data/lib/spartera_api_sdk/models/update_alerts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb → update_alerts200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_assets200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_assets_asset_id_patch200_response_data.rb → update_assets200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_companies200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_connections200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_connections_connection_id_patch200_response_data.rb → update_connections200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_favorites200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb → update_favorites200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_posts200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +165 -0
- data/lib/spartera_api_sdk/models/update_users200_response.rb +191 -0
- data/lib/spartera_api_sdk/models/{companies_company_id_users_user_id_patch200_response_data.rb → update_users200_response_data.rb} +5 -78
- data/lib/spartera_api_sdk/models/{user.rb → users.rb} +112 -108
- data/lib/spartera_api_sdk/models/{me_get200_response_profile.rb → users_input.rb} +54 -139
- data/lib/spartera_api_sdk/models/{me_get200_response_token_metadata.rb → users_update.rb} +101 -110
- data/lib/spartera_api_sdk/version.rb +13 -1
- data/lib/spartera_api_sdk.rb +149 -56
- data/spartera_api_sdk.gemspec +39 -0
- data/spec/api/alerts_api_spec.rb +50 -50
- data/spec/api/api_keys_api_spec.rb +67 -30
- data/spec/api/asset_price_history_api_spec.rb +57 -53
- data/spec/api/asset_usecases_api_spec.rb +61 -0
- data/spec/api/assets_api_spec.rb +134 -69
- data/spec/api/cloud_providers_api_spec.rb +16 -11
- data/spec/api/companies_api_spec.rb +99 -47
- data/spec/api/connections_api_spec.rb +53 -43
- data/spec/api/endpoints_api_spec.rb +215 -0
- data/spec/api/favorites_api_spec.rb +56 -56
- data/spec/api/industries_api_spec.rb +76 -0
- data/spec/api/job_functions_api_spec.rb +61 -0
- data/spec/api/postgen_integrations_api_spec.rb +117 -0
- data/spec/api/posts_api_spec.rb +186 -0
- data/spec/api/storage_engines_api_spec.rb +16 -11
- data/spec/api/users_api_spec.rb +83 -34
- data/spec/models/{me_get200_response_token_metadata_spec.rb → alerts_input_spec.rb} +12 -12
- data/spec/models/alerts_spec.rb +72 -0
- data/spec/models/alerts_update_spec.rb +54 -0
- data/spec/models/{apikey_spec.rb → api_keys_input_spec.rb} +14 -20
- data/spec/models/{assetpricehistory_spec.rb → api_keys_spec.rb} +25 -19
- data/spec/models/{user_spec.rb → api_keys_update_spec.rb} +15 -15
- data/spec/models/asset_price_history_input_spec.rb +54 -0
- data/spec/models/asset_price_history_spec.rb +72 -0
- data/spec/models/asset_price_history_update_spec.rb +54 -0
- data/spec/models/asset_usecases_spec.rb +66 -0
- data/spec/models/{asset_spec.rb → assets_input_spec.rb} +122 -28
- data/spec/models/assets_spec.rb +452 -0
- data/spec/models/assets_update_spec.rb +406 -0
- data/spec/models/{companies_company_id_assets_asset_id_get200_response_spec.rb → cloud_providers_input_spec.rb} +16 -10
- data/spec/models/{cloudprovider_spec.rb → cloud_providers_spec.rb} +14 -20
- data/spec/models/{companies_company_id_assets_asset_id_delete200_response_spec.rb → cloud_providers_update_spec.rb} +16 -10
- data/spec/models/companies_input_spec.rb +106 -0
- data/spec/models/{company_spec.rb → companies_spec.rb} +26 -16
- data/spec/models/companies_update_spec.rb +106 -0
- data/spec/models/connections_input_spec.rb +82 -0
- data/spec/models/{me_get200_response_spec.rb → connections_spec.rb} +28 -22
- data/spec/models/connections_update_spec.rb +82 -0
- data/spec/models/create_alerts200_response_data_spec.rb +36 -0
- data/spec/models/create_alerts200_response_spec.rb +42 -0
- data/spec/models/create_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/create_api_keys200_response_spec.rb +42 -0
- data/spec/models/create_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/{companies_company_id_assets_post200_response_spec.rb → create_asset_price_history200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_assets_post200_response_data_spec.rb → create_assets_analyze200_response_data_spec.rb} +8 -8
- data/spec/models/{companies_company_id_users_post200_response_spec.rb → create_assets_analyze200_response_spec.rb} +8 -8
- data/spec/models/{companies_company_id_connections_post200_response_data_spec.rb → create_connections200_response_data_spec.rb} +8 -8
- data/spec/models/create_connections200_response_spec.rb +42 -0
- data/spec/models/create_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/create_endpoints200_response_spec.rb +42 -0
- data/spec/models/create_favorites200_response_data_spec.rb +36 -0
- data/spec/models/create_favorites200_response_spec.rb +42 -0
- data/spec/models/create_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/create_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/create_posts200_response_data_spec.rb +36 -0
- data/spec/models/create_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_post200_response_data_spec.rb → create_users200_response_data_spec.rb} +8 -8
- data/spec/models/create_users200_response_spec.rb +42 -0
- data/spec/models/delete_alerts200_response_data_spec.rb +36 -0
- data/spec/models/delete_alerts200_response_spec.rb +42 -0
- data/spec/models/delete_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/delete_api_keys200_response_spec.rb +42 -0
- data/spec/models/delete_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/delete_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_asset_id_patch200_response_data_spec.rb → delete_assets200_response_data_spec.rb} +8 -8
- data/spec/models/delete_assets200_response_spec.rb +42 -0
- data/spec/models/delete_connections200_response_data_spec.rb +36 -0
- data/spec/models/delete_connections200_response_spec.rb +42 -0
- data/spec/models/delete_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/delete_endpoints200_response_spec.rb +42 -0
- data/spec/models/delete_favorites200_response_data_spec.rb +36 -0
- data/spec/models/delete_favorites200_response_spec.rb +42 -0
- data/spec/models/delete_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/delete_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/delete_posts200_response_data_spec.rb +36 -0
- data/spec/models/delete_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_patch200_response_data_spec.rb → delete_users200_response_data_spec.rb} +8 -8
- data/spec/models/delete_users200_response_spec.rb +42 -0
- data/spec/models/endpoints_input_spec.rb +236 -0
- data/spec/models/endpoints_spec.rb +242 -0
- data/spec/models/endpoints_update_spec.rb +236 -0
- data/spec/models/error_spec.rb +3 -3
- data/spec/models/favorites_input_spec.rb +66 -0
- data/spec/models/{favorite_spec.rb → favorites_spec.rb} +17 -23
- data/spec/models/favorites_update_spec.rb +66 -0
- data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_assets_get200_response_spec.rb → get_api_keys_by_id200_response_spec.rb} +8 -8
- data/spec/models/get_asset_price_history_by_id200_response_spec.rb +42 -0
- data/spec/models/get_asset_usecases_by_id200_response_spec.rb +42 -0
- data/spec/models/get_assets_by_id_analyze200_response_spec.rb +42 -0
- data/spec/models/get_cloud_providers_by_id200_response_spec.rb +42 -0
- data/spec/models/get_companies_by_id200_response_spec.rb +42 -0
- data/spec/models/get_connections_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_delete200_response_spec.rb → get_endpoints_by_id_connections_describe200_response_spec.rb} +8 -8
- data/spec/models/get_favorites_by_id200_response_spec.rb +42 -0
- data/spec/models/get_industries_by_id200_response_spec.rb +42 -0
- data/spec/models/get_job_functions_by_id200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_get200_response_spec.rb → get_postgen_integrations_by_id200_response_spec.rb} +8 -8
- data/spec/models/get_posts_by_id200_response_spec.rb +42 -0
- data/spec/models/get_storage_engines_by_id200_response_spec.rb +42 -0
- data/spec/models/get_users_by_id200_response_spec.rb +42 -0
- data/spec/models/industries_spec.rb +78 -0
- data/spec/models/inline_object1_spec.rb +3 -3
- data/spec/models/inline_object2_spec.rb +3 -3
- data/spec/models/inline_object3_spec.rb +3 -3
- data/spec/models/inline_object4_spec.rb +42 -0
- data/spec/models/inline_object5_spec.rb +42 -0
- data/spec/models/{companies_company_id_connections_get200_response_spec.rb → inline_object6_spec.rb} +15 -9
- data/spec/models/inline_object7_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +3 -3
- data/spec/models/job_functions_input_spec.rb +36 -0
- data/spec/models/job_functions_spec.rb +54 -0
- data/spec/models/job_functions_update_spec.rb +36 -0
- data/spec/models/list_api_keys200_response_spec.rb +42 -0
- data/spec/models/list_asset_usecases200_response_spec.rb +42 -0
- data/spec/models/list_assets200_response_spec.rb +42 -0
- data/spec/models/list_cloud_providers200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_api_keys_get200_response_spec.rb → list_companies_analytics_assets200_response_spec.rb} +8 -8
- data/spec/models/list_connections200_response_spec.rb +42 -0
- data/spec/models/list_endpoints200_response_spec.rb +42 -0
- data/spec/models/list_industries200_response_spec.rb +42 -0
- data/spec/models/list_job_functions200_response_spec.rb +42 -0
- data/spec/models/list_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/list_posts200_response_spec.rb +42 -0
- data/spec/models/list_storage_engines200_response_spec.rb +42 -0
- data/spec/models/list_users200_response_spec.rb +42 -0
- data/spec/models/post_publications_input_spec.rb +84 -0
- data/spec/models/post_publications_spec.rb +102 -0
- data/spec/models/post_publications_update_spec.rb +84 -0
- data/spec/models/postgen_integrations_input_spec.rb +72 -0
- data/spec/models/{alert_spec.rb → postgen_integrations_spec.rb} +17 -17
- data/spec/models/postgen_integrations_update_spec.rb +72 -0
- data/spec/models/{connection_spec.rb → posts_input_spec.rb} +51 -27
- data/spec/models/posts_spec.rb +186 -0
- data/spec/models/posts_update_spec.rb +168 -0
- data/spec/models/storage_engines_spec.rb +82 -0
- data/spec/models/update_alerts200_response_data_spec.rb +36 -0
- data/spec/models/update_alerts200_response_spec.rb +42 -0
- data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
- data/spec/models/update_api_keys200_response_spec.rb +42 -0
- data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
- data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
- data/spec/models/update_assets200_response_data_spec.rb +36 -0
- data/spec/models/update_assets200_response_spec.rb +42 -0
- data/spec/models/update_companies200_response_data_spec.rb +36 -0
- data/spec/models/update_companies200_response_spec.rb +42 -0
- data/spec/models/update_connections200_response_data_spec.rb +36 -0
- data/spec/models/update_connections200_response_spec.rb +42 -0
- data/spec/models/update_endpoints200_response_data_spec.rb +36 -0
- data/spec/models/update_endpoints200_response_spec.rb +42 -0
- data/spec/models/update_favorites200_response_data_spec.rb +36 -0
- data/spec/models/update_favorites200_response_spec.rb +42 -0
- data/spec/models/update_postgen_integrations200_response_data_spec.rb +36 -0
- data/spec/models/update_postgen_integrations200_response_spec.rb +42 -0
- data/spec/models/update_posts200_response_data_spec.rb +36 -0
- data/spec/models/update_posts200_response_spec.rb +42 -0
- data/spec/models/{companies_company_id_users_user_id_delete200_response_data_spec.rb → update_users200_response_data_spec.rb} +8 -8
- data/spec/models/update_users200_response_spec.rb +42 -0
- data/spec/models/users_input_spec.rb +76 -0
- data/spec/models/{me_get200_response_profile_spec.rb → users_spec.rb} +22 -22
- data/spec/models/users_update_spec.rb +76 -0
- data/spec/spec_helper.rb +2 -2
- metadata +623 -283
- data/docs/Alert.md +0 -36
- data/docs/Apikey.md +0 -36
- data/docs/Asset.md +0 -110
- data/docs/Assetpricehistory.md +0 -38
- data/docs/Cloudprovider.md +0 -30
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdAssetsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdConnectionsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +0 -20
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +0 -20
- data/docs/Company.md +0 -44
- data/docs/Connection.md +0 -54
- data/docs/Favorite.md +0 -36
- data/docs/MeGet200Response.md +0 -36
- data/docs/MeGet200ResponseApiKeyInfo.md +0 -20
- data/docs/MeGet200ResponseProfile.md +0 -36
- data/docs/MeGet200ResponseTokenMetadata.md +0 -24
- data/docs/User.md +0 -34
- data/example.rb +0 -51
- data/lib/spartera_api_sdk/models/asset.rb +0 -686
- data/lib/spartera_api_sdk/models/assetpricehistory.rb +0 -345
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +0 -266
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +0 -264
- data/lib/spartera_api_sdk/models/me_get200_response.rb +0 -417
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +0 -36
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +0 -42
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +0 -42
- data/spec/models/me_get200_response_api_key_info_spec.rb +0 -42
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# SparteraApiSdk::PostgenIntegrations
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date_created** | **Time** | Optional. | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | Optional. | [optional] |
|
|
9
|
+
| **integration_id** | **String** | Unique identifier. | [optional] |
|
|
10
|
+
| **company_id** | **String** | Company this integration belongs to | |
|
|
11
|
+
| **user_id** | **String** | User who created this integration | |
|
|
12
|
+
| **platform** | **String** | Platform identifier (beehiiv, wordpress, medium, etc) | |
|
|
13
|
+
| **platform_name** | **String** | Display name of the platform | |
|
|
14
|
+
| **credentials_secret_name** | **String** | GCP Secret Manager secret name containing encrypted credentials | |
|
|
15
|
+
| **is_active** | **Boolean** | Whether this integration is currently active | |
|
|
16
|
+
| **last_used_at** | **Time** | Last time this integration was used for publishing | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'spartera_api_sdk'
|
|
22
|
+
|
|
23
|
+
instance = SparteraApiSdk::PostgenIntegrations.new(
|
|
24
|
+
date_created: 2025-04-01T00:00:00Z,
|
|
25
|
+
last_updated: 2025-04-01T00:00:00Z,
|
|
26
|
+
integration_id: integration_id_abc123,
|
|
27
|
+
company_id: company_id_abc123,
|
|
28
|
+
user_id: user_id_abc123,
|
|
29
|
+
platform: example_value,
|
|
30
|
+
platform_name: Example Name,
|
|
31
|
+
credentials_secret_name: Example Name,
|
|
32
|
+
is_active: true,
|
|
33
|
+
last_used_at: 2025-04-01T00:00:00Z
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,463 @@
|
|
|
1
|
+
# SparteraApiSdk::PostgenIntegrationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spartera.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_postgen_integrations**](PostgenIntegrationsApi.md#create_postgen_integrations) | **POST** /companies/{company_id}/postgen_integrations | POST /companies/{company_id}/postgen_integrations |
|
|
8
|
+
| [**create_postgen_integrations_test**](PostgenIntegrationsApi.md#create_postgen_integrations_test) | **POST** /companies/{company_id}/postgen_integrations/test | POST /companies/{company_id}/postgen_integrations/test |
|
|
9
|
+
| [**delete_postgen_integrations**](PostgenIntegrationsApi.md#delete_postgen_integrations) | **DELETE** /companies/{company_id}/postgen_integrations/{integration_id} | Delete single integration by ID. Also deletes credentials from GCP Secret Manager. |
|
|
10
|
+
| [**get_postgen_integrations_by_id**](PostgenIntegrationsApi.md#get_postgen_integrations_by_id) | **GET** /companies/{company_id}/postgen_integrations/{integration_id} | Get single integration by ID. |
|
|
11
|
+
| [**list_postgen_integrations**](PostgenIntegrationsApi.md#list_postgen_integrations) | **GET** /companies/{company_id}/postgen_integrations | Get a list of all postgen integrations for the company. All company users can view integrations. |
|
|
12
|
+
| [**update_postgen_integrations**](PostgenIntegrationsApi.md#update_postgen_integrations) | **PATCH** /companies/{company_id}/postgen_integrations/{integration_id} | Update an existing integration by ID. Can update credentials, is_active status, etc. |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## create_postgen_integrations
|
|
16
|
+
|
|
17
|
+
> <CreatePostgenIntegrations200Response> create_postgen_integrations(company_id, postgen_integrations_input, opts)
|
|
18
|
+
|
|
19
|
+
POST /companies/{company_id}/postgen_integrations
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'spartera_api_sdk'
|
|
26
|
+
# setup authorization
|
|
27
|
+
SparteraApiSdk.configure do |config|
|
|
28
|
+
# Configure API key authorization: ApiKeyAuth
|
|
29
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
31
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
35
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
36
|
+
postgen_integrations_input = SparteraApiSdk::PostgenIntegrationsInput.new({company_id: 'company_id_abc123', user_id: 'user_id_abc123', platform: 'example_value', platform_name: 'Example Name', credentials_secret_name: 'Example Name'}) # PostgenIntegrationsInput |
|
|
37
|
+
opts = {
|
|
38
|
+
page: 56, # Integer | Page number for pagination
|
|
39
|
+
limit: 56, # Integer | Number of items per page
|
|
40
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
41
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
42
|
+
search: 'search_example' # String | Search term to filter results
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
# POST /companies/{company_id}/postgen_integrations
|
|
47
|
+
result = api_instance.create_postgen_integrations(company_id, postgen_integrations_input, opts)
|
|
48
|
+
p result
|
|
49
|
+
rescue SparteraApiSdk::ApiError => e
|
|
50
|
+
puts "Error when calling PostgenIntegrationsApi->create_postgen_integrations: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
#### Using the create_postgen_integrations_with_http_info variant
|
|
55
|
+
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
|
57
|
+
|
|
58
|
+
> <Array(<CreatePostgenIntegrations200Response>, Integer, Hash)> create_postgen_integrations_with_http_info(company_id, postgen_integrations_input, opts)
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
begin
|
|
62
|
+
# POST /companies/{company_id}/postgen_integrations
|
|
63
|
+
data, status_code, headers = api_instance.create_postgen_integrations_with_http_info(company_id, postgen_integrations_input, opts)
|
|
64
|
+
p status_code # => 2xx
|
|
65
|
+
p headers # => { ... }
|
|
66
|
+
p data # => <CreatePostgenIntegrations200Response>
|
|
67
|
+
rescue SparteraApiSdk::ApiError => e
|
|
68
|
+
puts "Error when calling PostgenIntegrationsApi->create_postgen_integrations_with_http_info: #{e}"
|
|
69
|
+
end
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
| Name | Type | Description | Notes |
|
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
|
76
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
77
|
+
| **postgen_integrations_input** | [**PostgenIntegrationsInput**](PostgenIntegrationsInput.md) | | |
|
|
78
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
79
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
80
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
81
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
82
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
83
|
+
|
|
84
|
+
### Return type
|
|
85
|
+
|
|
86
|
+
[**CreatePostgenIntegrations200Response**](CreatePostgenIntegrations200Response.md)
|
|
87
|
+
|
|
88
|
+
### Authorization
|
|
89
|
+
|
|
90
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
91
|
+
|
|
92
|
+
### HTTP request headers
|
|
93
|
+
|
|
94
|
+
- **Content-Type**: application/json
|
|
95
|
+
- **Accept**: application/json
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## create_postgen_integrations_test
|
|
99
|
+
|
|
100
|
+
> <CreatePostgenIntegrations200Response> create_postgen_integrations_test(company_id, postgen_integrations_input)
|
|
101
|
+
|
|
102
|
+
POST /companies/{company_id}/postgen_integrations/test
|
|
103
|
+
|
|
104
|
+
### Examples
|
|
105
|
+
|
|
106
|
+
```ruby
|
|
107
|
+
require 'time'
|
|
108
|
+
require 'spartera_api_sdk'
|
|
109
|
+
# setup authorization
|
|
110
|
+
SparteraApiSdk.configure do |config|
|
|
111
|
+
# Configure API key authorization: ApiKeyAuth
|
|
112
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
113
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
114
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
118
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
119
|
+
postgen_integrations_input = SparteraApiSdk::PostgenIntegrationsInput.new({company_id: 'company_id_abc123', user_id: 'user_id_abc123', platform: 'example_value', platform_name: 'Example Name', credentials_secret_name: 'Example Name'}) # PostgenIntegrationsInput |
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
# POST /companies/{company_id}/postgen_integrations/test
|
|
123
|
+
result = api_instance.create_postgen_integrations_test(company_id, postgen_integrations_input)
|
|
124
|
+
p result
|
|
125
|
+
rescue SparteraApiSdk::ApiError => e
|
|
126
|
+
puts "Error when calling PostgenIntegrationsApi->create_postgen_integrations_test: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
#### Using the create_postgen_integrations_test_with_http_info variant
|
|
131
|
+
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
133
|
+
|
|
134
|
+
> <Array(<CreatePostgenIntegrations200Response>, Integer, Hash)> create_postgen_integrations_test_with_http_info(company_id, postgen_integrations_input)
|
|
135
|
+
|
|
136
|
+
```ruby
|
|
137
|
+
begin
|
|
138
|
+
# POST /companies/{company_id}/postgen_integrations/test
|
|
139
|
+
data, status_code, headers = api_instance.create_postgen_integrations_test_with_http_info(company_id, postgen_integrations_input)
|
|
140
|
+
p status_code # => 2xx
|
|
141
|
+
p headers # => { ... }
|
|
142
|
+
p data # => <CreatePostgenIntegrations200Response>
|
|
143
|
+
rescue SparteraApiSdk::ApiError => e
|
|
144
|
+
puts "Error when calling PostgenIntegrationsApi->create_postgen_integrations_test_with_http_info: #{e}"
|
|
145
|
+
end
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
|
152
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
153
|
+
| **postgen_integrations_input** | [**PostgenIntegrationsInput**](PostgenIntegrationsInput.md) | | |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**CreatePostgenIntegrations200Response**](CreatePostgenIntegrations200Response.md)
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: application/json
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
## delete_postgen_integrations
|
|
170
|
+
|
|
171
|
+
> <DeletePostgenIntegrations200Response> delete_postgen_integrations(company_id, integration_id)
|
|
172
|
+
|
|
173
|
+
Delete single integration by ID. Also deletes credentials from GCP Secret Manager.
|
|
174
|
+
|
|
175
|
+
### Examples
|
|
176
|
+
|
|
177
|
+
```ruby
|
|
178
|
+
require 'time'
|
|
179
|
+
require 'spartera_api_sdk'
|
|
180
|
+
# setup authorization
|
|
181
|
+
SparteraApiSdk.configure do |config|
|
|
182
|
+
# Configure API key authorization: ApiKeyAuth
|
|
183
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
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'
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
189
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
190
|
+
integration_id = 'integration_id_example' # String | Unique identifier for the Integration
|
|
191
|
+
|
|
192
|
+
begin
|
|
193
|
+
# Delete single integration by ID. Also deletes credentials from GCP Secret Manager.
|
|
194
|
+
result = api_instance.delete_postgen_integrations(company_id, integration_id)
|
|
195
|
+
p result
|
|
196
|
+
rescue SparteraApiSdk::ApiError => e
|
|
197
|
+
puts "Error when calling PostgenIntegrationsApi->delete_postgen_integrations: #{e}"
|
|
198
|
+
end
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
#### Using the delete_postgen_integrations_with_http_info variant
|
|
202
|
+
|
|
203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
204
|
+
|
|
205
|
+
> <Array(<DeletePostgenIntegrations200Response>, Integer, Hash)> delete_postgen_integrations_with_http_info(company_id, integration_id)
|
|
206
|
+
|
|
207
|
+
```ruby
|
|
208
|
+
begin
|
|
209
|
+
# Delete single integration by ID. Also deletes credentials from GCP Secret Manager.
|
|
210
|
+
data, status_code, headers = api_instance.delete_postgen_integrations_with_http_info(company_id, integration_id)
|
|
211
|
+
p status_code # => 2xx
|
|
212
|
+
p headers # => { ... }
|
|
213
|
+
p data # => <DeletePostgenIntegrations200Response>
|
|
214
|
+
rescue SparteraApiSdk::ApiError => e
|
|
215
|
+
puts "Error when calling PostgenIntegrationsApi->delete_postgen_integrations_with_http_info: #{e}"
|
|
216
|
+
end
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
| Name | Type | Description | Notes |
|
|
222
|
+
| ---- | ---- | ----------- | ----- |
|
|
223
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
224
|
+
| **integration_id** | **String** | Unique identifier for the Integration | |
|
|
225
|
+
|
|
226
|
+
### Return type
|
|
227
|
+
|
|
228
|
+
[**DeletePostgenIntegrations200Response**](DeletePostgenIntegrations200Response.md)
|
|
229
|
+
|
|
230
|
+
### Authorization
|
|
231
|
+
|
|
232
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
233
|
+
|
|
234
|
+
### HTTP request headers
|
|
235
|
+
|
|
236
|
+
- **Content-Type**: Not defined
|
|
237
|
+
- **Accept**: application/json
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
## get_postgen_integrations_by_id
|
|
241
|
+
|
|
242
|
+
> <GetPostgenIntegrationsById200Response> get_postgen_integrations_by_id(company_id, integration_id)
|
|
243
|
+
|
|
244
|
+
Get single integration by ID.
|
|
245
|
+
|
|
246
|
+
### Examples
|
|
247
|
+
|
|
248
|
+
```ruby
|
|
249
|
+
require 'time'
|
|
250
|
+
require 'spartera_api_sdk'
|
|
251
|
+
# setup authorization
|
|
252
|
+
SparteraApiSdk.configure do |config|
|
|
253
|
+
# Configure API key authorization: ApiKeyAuth
|
|
254
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
255
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
256
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
260
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
261
|
+
integration_id = 'integration_id_example' # String | Unique identifier for the Integration
|
|
262
|
+
|
|
263
|
+
begin
|
|
264
|
+
# Get single integration by ID.
|
|
265
|
+
result = api_instance.get_postgen_integrations_by_id(company_id, integration_id)
|
|
266
|
+
p result
|
|
267
|
+
rescue SparteraApiSdk::ApiError => e
|
|
268
|
+
puts "Error when calling PostgenIntegrationsApi->get_postgen_integrations_by_id: #{e}"
|
|
269
|
+
end
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
#### Using the get_postgen_integrations_by_id_with_http_info variant
|
|
273
|
+
|
|
274
|
+
This returns an Array which contains the response data, status code and headers.
|
|
275
|
+
|
|
276
|
+
> <Array(<GetPostgenIntegrationsById200Response>, Integer, Hash)> get_postgen_integrations_by_id_with_http_info(company_id, integration_id)
|
|
277
|
+
|
|
278
|
+
```ruby
|
|
279
|
+
begin
|
|
280
|
+
# Get single integration by ID.
|
|
281
|
+
data, status_code, headers = api_instance.get_postgen_integrations_by_id_with_http_info(company_id, integration_id)
|
|
282
|
+
p status_code # => 2xx
|
|
283
|
+
p headers # => { ... }
|
|
284
|
+
p data # => <GetPostgenIntegrationsById200Response>
|
|
285
|
+
rescue SparteraApiSdk::ApiError => e
|
|
286
|
+
puts "Error when calling PostgenIntegrationsApi->get_postgen_integrations_by_id_with_http_info: #{e}"
|
|
287
|
+
end
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
| Name | Type | Description | Notes |
|
|
293
|
+
| ---- | ---- | ----------- | ----- |
|
|
294
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
295
|
+
| **integration_id** | **String** | Unique identifier for the Integration | |
|
|
296
|
+
|
|
297
|
+
### Return type
|
|
298
|
+
|
|
299
|
+
[**GetPostgenIntegrationsById200Response**](GetPostgenIntegrationsById200Response.md)
|
|
300
|
+
|
|
301
|
+
### Authorization
|
|
302
|
+
|
|
303
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
304
|
+
|
|
305
|
+
### HTTP request headers
|
|
306
|
+
|
|
307
|
+
- **Content-Type**: Not defined
|
|
308
|
+
- **Accept**: application/json
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
## list_postgen_integrations
|
|
312
|
+
|
|
313
|
+
> <ListPostgenIntegrations200Response> list_postgen_integrations(company_id, opts)
|
|
314
|
+
|
|
315
|
+
Get a list of all postgen integrations for the company. All company users can view integrations.
|
|
316
|
+
|
|
317
|
+
### Examples
|
|
318
|
+
|
|
319
|
+
```ruby
|
|
320
|
+
require 'time'
|
|
321
|
+
require 'spartera_api_sdk'
|
|
322
|
+
# setup authorization
|
|
323
|
+
SparteraApiSdk.configure do |config|
|
|
324
|
+
# Configure API key authorization: ApiKeyAuth
|
|
325
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
326
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
327
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
331
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
332
|
+
opts = {
|
|
333
|
+
page: 56, # Integer | Page number for pagination
|
|
334
|
+
limit: 56, # Integer | Number of items per page
|
|
335
|
+
sort_by: 'sort_by_example', # String | Field to sort by
|
|
336
|
+
sort_order: 'asc', # String | Sort order (ascending or descending)
|
|
337
|
+
search: 'search_example' # String | Search term to filter results
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
begin
|
|
341
|
+
# Get a list of all postgen integrations for the company. All company users can view integrations.
|
|
342
|
+
result = api_instance.list_postgen_integrations(company_id, opts)
|
|
343
|
+
p result
|
|
344
|
+
rescue SparteraApiSdk::ApiError => e
|
|
345
|
+
puts "Error when calling PostgenIntegrationsApi->list_postgen_integrations: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
#### Using the list_postgen_integrations_with_http_info variant
|
|
350
|
+
|
|
351
|
+
This returns an Array which contains the response data, status code and headers.
|
|
352
|
+
|
|
353
|
+
> <Array(<ListPostgenIntegrations200Response>, Integer, Hash)> list_postgen_integrations_with_http_info(company_id, opts)
|
|
354
|
+
|
|
355
|
+
```ruby
|
|
356
|
+
begin
|
|
357
|
+
# Get a list of all postgen integrations for the company. All company users can view integrations.
|
|
358
|
+
data, status_code, headers = api_instance.list_postgen_integrations_with_http_info(company_id, opts)
|
|
359
|
+
p status_code # => 2xx
|
|
360
|
+
p headers # => { ... }
|
|
361
|
+
p data # => <ListPostgenIntegrations200Response>
|
|
362
|
+
rescue SparteraApiSdk::ApiError => e
|
|
363
|
+
puts "Error when calling PostgenIntegrationsApi->list_postgen_integrations_with_http_info: #{e}"
|
|
364
|
+
end
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Parameters
|
|
368
|
+
|
|
369
|
+
| Name | Type | Description | Notes |
|
|
370
|
+
| ---- | ---- | ----------- | ----- |
|
|
371
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
372
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
373
|
+
| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
|
|
374
|
+
| **sort_by** | **String** | Field to sort by | [optional] |
|
|
375
|
+
| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to 'desc'] |
|
|
376
|
+
| **search** | **String** | Search term to filter results | [optional] |
|
|
377
|
+
|
|
378
|
+
### Return type
|
|
379
|
+
|
|
380
|
+
[**ListPostgenIntegrations200Response**](ListPostgenIntegrations200Response.md)
|
|
381
|
+
|
|
382
|
+
### Authorization
|
|
383
|
+
|
|
384
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
385
|
+
|
|
386
|
+
### HTTP request headers
|
|
387
|
+
|
|
388
|
+
- **Content-Type**: Not defined
|
|
389
|
+
- **Accept**: application/json
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
## update_postgen_integrations
|
|
393
|
+
|
|
394
|
+
> <UpdatePostgenIntegrations200Response> update_postgen_integrations(company_id, integration_id, postgen_integrations_update)
|
|
395
|
+
|
|
396
|
+
Update an existing integration by ID. Can update credentials, is_active status, etc.
|
|
397
|
+
|
|
398
|
+
### Examples
|
|
399
|
+
|
|
400
|
+
```ruby
|
|
401
|
+
require 'time'
|
|
402
|
+
require 'spartera_api_sdk'
|
|
403
|
+
# setup authorization
|
|
404
|
+
SparteraApiSdk.configure do |config|
|
|
405
|
+
# Configure API key authorization: ApiKeyAuth
|
|
406
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
408
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
api_instance = SparteraApiSdk::PostgenIntegrationsApi.new
|
|
412
|
+
company_id = 'company_id_example' # String | Unique identifier for the Company
|
|
413
|
+
integration_id = 'integration_id_example' # String | Unique identifier for the Integration
|
|
414
|
+
postgen_integrations_update = SparteraApiSdk::PostgenIntegrationsUpdate.new # PostgenIntegrationsUpdate |
|
|
415
|
+
|
|
416
|
+
begin
|
|
417
|
+
# Update an existing integration by ID. Can update credentials, is_active status, etc.
|
|
418
|
+
result = api_instance.update_postgen_integrations(company_id, integration_id, postgen_integrations_update)
|
|
419
|
+
p result
|
|
420
|
+
rescue SparteraApiSdk::ApiError => e
|
|
421
|
+
puts "Error when calling PostgenIntegrationsApi->update_postgen_integrations: #{e}"
|
|
422
|
+
end
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
#### Using the update_postgen_integrations_with_http_info variant
|
|
426
|
+
|
|
427
|
+
This returns an Array which contains the response data, status code and headers.
|
|
428
|
+
|
|
429
|
+
> <Array(<UpdatePostgenIntegrations200Response>, Integer, Hash)> update_postgen_integrations_with_http_info(company_id, integration_id, postgen_integrations_update)
|
|
430
|
+
|
|
431
|
+
```ruby
|
|
432
|
+
begin
|
|
433
|
+
# Update an existing integration by ID. Can update credentials, is_active status, etc.
|
|
434
|
+
data, status_code, headers = api_instance.update_postgen_integrations_with_http_info(company_id, integration_id, postgen_integrations_update)
|
|
435
|
+
p status_code # => 2xx
|
|
436
|
+
p headers # => { ... }
|
|
437
|
+
p data # => <UpdatePostgenIntegrations200Response>
|
|
438
|
+
rescue SparteraApiSdk::ApiError => e
|
|
439
|
+
puts "Error when calling PostgenIntegrationsApi->update_postgen_integrations_with_http_info: #{e}"
|
|
440
|
+
end
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Parameters
|
|
444
|
+
|
|
445
|
+
| Name | Type | Description | Notes |
|
|
446
|
+
| ---- | ---- | ----------- | ----- |
|
|
447
|
+
| **company_id** | **String** | Unique identifier for the Company | |
|
|
448
|
+
| **integration_id** | **String** | Unique identifier for the Integration | |
|
|
449
|
+
| **postgen_integrations_update** | [**PostgenIntegrationsUpdate**](PostgenIntegrationsUpdate.md) | | |
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**UpdatePostgenIntegrations200Response**](UpdatePostgenIntegrations200Response.md)
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: application/json
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# SparteraApiSdk::PostgenIntegrationsInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_id** | **String** | Company this integration belongs to | |
|
|
8
|
+
| **user_id** | **String** | User who created this integration | |
|
|
9
|
+
| **platform** | **String** | Platform identifier (beehiiv, wordpress, medium, etc) | |
|
|
10
|
+
| **platform_name** | **String** | Display name of the platform | |
|
|
11
|
+
| **credentials_secret_name** | **String** | GCP Secret Manager secret name containing encrypted credentials | |
|
|
12
|
+
| **is_active** | **Boolean** | Whether this integration is currently active | [optional] |
|
|
13
|
+
| **last_used_at** | **Time** | Last time this integration was used for publishing | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'spartera_api_sdk'
|
|
19
|
+
|
|
20
|
+
instance = SparteraApiSdk::PostgenIntegrationsInput.new(
|
|
21
|
+
company_id: company_id_abc123,
|
|
22
|
+
user_id: user_id_abc123,
|
|
23
|
+
platform: example_value,
|
|
24
|
+
platform_name: Example Name,
|
|
25
|
+
credentials_secret_name: Example Name,
|
|
26
|
+
is_active: true,
|
|
27
|
+
last_used_at: 2025-04-01T00:00:00Z
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# SparteraApiSdk::PostgenIntegrationsUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **company_id** | **String** | Company this integration belongs to | [optional] |
|
|
8
|
+
| **user_id** | **String** | User who created this integration | [optional] |
|
|
9
|
+
| **platform** | **String** | Platform identifier (beehiiv, wordpress, medium, etc) | [optional] |
|
|
10
|
+
| **platform_name** | **String** | Display name of the platform | [optional] |
|
|
11
|
+
| **credentials_secret_name** | **String** | GCP Secret Manager secret name containing encrypted credentials | [optional] |
|
|
12
|
+
| **is_active** | **Boolean** | Whether this integration is currently active | [optional] |
|
|
13
|
+
| **last_used_at** | **Time** | Last time this integration was used for publishing | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'spartera_api_sdk'
|
|
19
|
+
|
|
20
|
+
instance = SparteraApiSdk::PostgenIntegrationsUpdate.new(
|
|
21
|
+
company_id: company_id_abc123,
|
|
22
|
+
user_id: user_id_abc123,
|
|
23
|
+
platform: example_value,
|
|
24
|
+
platform_name: Example Name,
|
|
25
|
+
credentials_secret_name: Example Name,
|
|
26
|
+
is_active: true,
|
|
27
|
+
last_used_at: 2025-04-01T00:00:00Z
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
data/docs/Posts.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# SparteraApiSdk::Posts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **date_created** | **Time** | Optional. | [optional] |
|
|
8
|
+
| **last_updated** | **Time** | Optional. | [optional] |
|
|
9
|
+
| **post_id** | **String** | Unique identifier. | [optional] |
|
|
10
|
+
| **user_id** | **String** | User who created this post | |
|
|
11
|
+
| **company_id** | **String** | Company this post belongs to | |
|
|
12
|
+
| **title** | **String** | Article title | |
|
|
13
|
+
| **category** | **String** | Article category (e.g., 'Sports', 'Business') | [optional] |
|
|
14
|
+
| **teaser** | **String** | Article teaser/subtitle | [optional] |
|
|
15
|
+
| **content_html** | **String** | Generated article HTML content | |
|
|
16
|
+
| **insights_used** | **Object** | Array of insights used: [{asset_id, asset_name, value, runtime, success}] | [optional] |
|
|
17
|
+
| **generation_creativity** | **Integer** | Creativity level (0-100), maps to AI temperature | [optional] |
|
|
18
|
+
| **generation_target_word_count** | **Integer** | Target word count (null = auto) | [optional] |
|
|
19
|
+
| **generation_tone** | **String** | Writing tone: professional, casual, technical, conversational | [optional] |
|
|
20
|
+
| **generation_include_citations** | **Boolean** | Whether to include data source citations | [optional] |
|
|
21
|
+
| **generation_subheading_count** | **Integer** | Number of subheadings (2-5) | [optional] |
|
|
22
|
+
| **generation_temperature** | **Float** | Actual temperature used for generation (0.0-2.0) | [optional] |
|
|
23
|
+
| **data_cost_credits** | **Integer** | Cost in credits for data insights | |
|
|
24
|
+
| **service_cost_credits** | **Integer** | Cost in credits for AI generation service | |
|
|
25
|
+
| **total_cost_credits** | **Integer** | Total cost in credits (data + service) | |
|
|
26
|
+
| **successful_insights_count** | **Integer** | Number of insights that succeeded | |
|
|
27
|
+
| **failed_insights_count** | **Integer** | Number of insights that failed | |
|
|
28
|
+
| **generation_time_ms** | **Integer** | Time taken to generate article in milliseconds | [optional] |
|
|
29
|
+
| **is_published** | **Boolean** | Whether this post has been published | |
|
|
30
|
+
| **published_at** | **Time** | When this post was published | [optional] |
|
|
31
|
+
| **view_count** | **Integer** | Number of times this post has been viewed | |
|
|
32
|
+
| **last_edited_at** | **Time** | When this post was last edited | [optional] |
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```ruby
|
|
37
|
+
require 'spartera_api_sdk'
|
|
38
|
+
|
|
39
|
+
instance = SparteraApiSdk::Posts.new(
|
|
40
|
+
date_created: 2025-04-01T00:00:00Z,
|
|
41
|
+
last_updated: 2025-04-01T00:00:00Z,
|
|
42
|
+
post_id: post_id_abc123,
|
|
43
|
+
user_id: user_id_abc123,
|
|
44
|
+
company_id: company_id_abc123,
|
|
45
|
+
title: example_value,
|
|
46
|
+
category: example_value,
|
|
47
|
+
teaser: example_value,
|
|
48
|
+
content_html: example_value,
|
|
49
|
+
insights_used: {},
|
|
50
|
+
generation_creativity: 1,
|
|
51
|
+
generation_target_word_count: 1,
|
|
52
|
+
generation_tone: example_value,
|
|
53
|
+
generation_include_citations: true,
|
|
54
|
+
generation_subheading_count: 1,
|
|
55
|
+
generation_temperature: 1.0,
|
|
56
|
+
data_cost_credits: 1,
|
|
57
|
+
service_cost_credits: 1,
|
|
58
|
+
total_cost_credits: 1,
|
|
59
|
+
successful_insights_count: 1,
|
|
60
|
+
failed_insights_count: 1,
|
|
61
|
+
generation_time_ms: 1,
|
|
62
|
+
is_published: true,
|
|
63
|
+
published_at: 2025-04-01T00:00:00Z,
|
|
64
|
+
view_count: 1,
|
|
65
|
+
last_edited_at: 2025-04-01T00:00:00Z
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|