spartera_api_sdk 0.3.6

data/docs/PostsInput.md

@@ -0,0 +1,62 @@
+# SparteraApiSdk::PostsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | User who created this post |  |
+| **company_id** | **String** | Company this post belongs to |  |
+| **title** | **String** | Article title |  |
+| **category** | **String** | Article category (e.g., 'Sports', 'Business') | [optional] |
+| **teaser** | **String** | Article teaser/subtitle | [optional] |
+| **content_html** | **String** | Generated article HTML content |  |
+| **insights_used** | **Object** | Array of insights used: [{asset_id, asset_name, value, runtime, success}] | [optional] |
+| **generation_creativity** | **Integer** | Creativity level (0-100), maps to AI temperature | [optional] |
+| **generation_target_word_count** | **Integer** | Target word count (null = auto) | [optional] |
+| **generation_tone** | **String** | Writing tone: professional, casual, technical, conversational | [optional] |
+| **generation_include_citations** | **Boolean** | Whether to include data source citations | [optional] |
+| **generation_subheading_count** | **Integer** | Number of subheadings (2-5) | [optional] |
+| **generation_temperature** | **Float** | Actual temperature used for generation (0.0-2.0) | [optional] |
+| **data_cost_credits** | **Integer** | Cost in credits for data insights | [optional] |
+| **service_cost_credits** | **Integer** | Cost in credits for AI generation service | [optional] |
+| **total_cost_credits** | **Integer** | Total cost in credits (data + service) | [optional] |
+| **successful_insights_count** | **Integer** | Number of insights that succeeded | [optional] |
+| **failed_insights_count** | **Integer** | Number of insights that failed | [optional] |
+| **generation_time_ms** | **Integer** | Time taken to generate article in milliseconds | [optional] |
+| **is_published** | **Boolean** | Whether this post has been published | [optional] |
+| **published_at** | **Time** | When this post was published | [optional] |
+| **view_count** | **Integer** | Number of times this post has been viewed | [optional] |
+| **last_edited_at** | **Time** | When this post was last edited | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostsInput.new(
+  user_id: user_id_abc123,
+  company_id: company_id_abc123,
+  title: example_value,
+  category: example_value,
+  teaser: example_value,
+  content_html: example_value,
+  insights_used: {},
+  generation_creativity: 1,
+  generation_target_word_count: 1,
+  generation_tone: example_value,
+  generation_include_citations: true,
+  generation_subheading_count: 1,
+  generation_temperature: 1.0,
+  data_cost_credits: 1,
+  service_cost_credits: 1,
+  total_cost_credits: 1,
+  successful_insights_count: 1,
+  failed_insights_count: 1,
+  generation_time_ms: 1,
+  is_published: true,
+  published_at: 2025-04-01T00:00:00Z,
+  view_count: 1,
+  last_edited_at: 2025-04-01T00:00:00Z
+)
+```
+

data/docs/PostsUpdate.md

@@ -0,0 +1,62 @@
+# SparteraApiSdk::PostsUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | User who created this post | [optional] |
+| **company_id** | **String** | Company this post belongs to | [optional] |
+| **title** | **String** | Article title | [optional] |
+| **category** | **String** | Article category (e.g., 'Sports', 'Business') | [optional] |
+| **teaser** | **String** | Article teaser/subtitle | [optional] |
+| **content_html** | **String** | Generated article HTML content | [optional] |
+| **insights_used** | **Object** | Array of insights used: [{asset_id, asset_name, value, runtime, success}] | [optional] |
+| **generation_creativity** | **Integer** | Creativity level (0-100), maps to AI temperature | [optional] |
+| **generation_target_word_count** | **Integer** | Target word count (null = auto) | [optional] |
+| **generation_tone** | **String** | Writing tone: professional, casual, technical, conversational | [optional] |
+| **generation_include_citations** | **Boolean** | Whether to include data source citations | [optional] |
+| **generation_subheading_count** | **Integer** | Number of subheadings (2-5) | [optional] |
+| **generation_temperature** | **Float** | Actual temperature used for generation (0.0-2.0) | [optional] |
+| **data_cost_credits** | **Integer** | Cost in credits for data insights | [optional] |
+| **service_cost_credits** | **Integer** | Cost in credits for AI generation service | [optional] |
+| **total_cost_credits** | **Integer** | Total cost in credits (data + service) | [optional] |
+| **successful_insights_count** | **Integer** | Number of insights that succeeded | [optional] |
+| **failed_insights_count** | **Integer** | Number of insights that failed | [optional] |
+| **generation_time_ms** | **Integer** | Time taken to generate article in milliseconds | [optional] |
+| **is_published** | **Boolean** | Whether this post has been published | [optional] |
+| **published_at** | **Time** | When this post was published | [optional] |
+| **view_count** | **Integer** | Number of times this post has been viewed | [optional] |
+| **last_edited_at** | **Time** | When this post was last edited | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostsUpdate.new(
+  user_id: user_id_abc123,
+  company_id: company_id_abc123,
+  title: example_value,
+  category: example_value,
+  teaser: example_value,
+  content_html: example_value,
+  insights_used: {},
+  generation_creativity: 1,
+  generation_target_word_count: 1,
+  generation_tone: example_value,
+  generation_include_citations: true,
+  generation_subheading_count: 1,
+  generation_temperature: 1.0,
+  data_cost_credits: 1,
+  service_cost_credits: 1,
+  total_cost_credits: 1,
+  successful_insights_count: 1,
+  failed_insights_count: 1,
+  generation_time_ms: 1,
+  is_published: true,
+  published_at: 2025-04-01T00:00:00Z,
+  view_count: 1,
+  last_edited_at: 2025-04-01T00:00:00Z
+)
+```
+

data/docs/StorageEngines.md

@@ -0,0 +1,32 @@
+# SparteraApiSdk::StorageEngines
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | Optional. | [optional] |
+| **last_updated** | **Time** | Optional. | [optional] |
+| **engine_id** | **Integer** | Unique identifier. | [optional] |
+| **provider_id** | **Integer** | References cloud_providers.provider_id — Supported cloud platforms and database engines available for connections. See GET /cloud_providers for valid values. Required. |  |
+| **service_name** | **String** | Required. |  |
+| **engine_type** | **String** | Required. One of: EDW, LLM, RDBMS, OBJ, API_MODEL, … (6 total). |  |
+| **integration_complete** | **Boolean** | Optional. | [optional] |
+| **test_func_complete** | **Boolean** | Optional. | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::StorageEngines.new(
+  date_created: 2025-04-01T00:00:00Z,
+  last_updated: 2025-04-01T00:00:00Z,
+  engine_id: 1,
+  provider_id: 1,
+  service_name: Example Name,
+  engine_type: EDW,
+  integration_complete: true,
+  test_func_complete: true
+)
+```
+

data/docs/StorageEnginesApi.md

@@ -0,0 +1,161 @@
+# SparteraApiSdk::StorageEnginesApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_storage_engines_by_id**](StorageEnginesApi.md#get_storage_engines_by_id) | **GET** /cloud-providers/{provider_id}/storage-engines/{engine_id} | Get single storage engine by ID |
+| [**list_storage_engines**](StorageEnginesApi.md#list_storage_engines) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines |
+
+
+## get_storage_engines_by_id
+
+> <GetStorageEnginesById200Response> get_storage_engines_by_id(provider_id, engine_id)
+
+Get single storage engine by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SparteraApiSdk::StorageEnginesApi.new
+provider_id = 'provider_id_example' # String | Unique identifier for the Provider
+engine_id = 'engine_id_example' # String | Unique identifier for the Engine
+
+begin
+  # Get single storage engine by ID
+  result = api_instance.get_storage_engines_by_id(provider_id, engine_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->get_storage_engines_by_id: #{e}"
+end
+```
+
+#### Using the get_storage_engines_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStorageEnginesById200Response>, Integer, Hash)> get_storage_engines_by_id_with_http_info(provider_id, engine_id)
+
+```ruby
+begin
+  # Get single storage engine by ID
+  data, status_code, headers = api_instance.get_storage_engines_by_id_with_http_info(provider_id, engine_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStorageEnginesById200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->get_storage_engines_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_id** | **String** | Unique identifier for the Provider |  |
+| **engine_id** | **String** | Unique identifier for the Engine |  |
+
+### Return type
+
+[**GetStorageEnginesById200Response**](GetStorageEnginesById200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_storage_engines
+
+> <ListStorageEngines200Response> list_storage_engines(provider_id, opts)
+
+Get a list of all storage engines
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SparteraApiSdk::StorageEnginesApi.new
+provider_id = 'provider_id_example' # String | Unique identifier for the Provider
+opts = {
+  page: 56, # Integer | Page number for pagination
+  limit: 56, # Integer | Number of items per page
+  sort_by: 'sort_by_example', # String | Field to sort by
+  sort_order: 'asc', # String | Sort order (ascending or descending)
+  search: 'search_example' # String | Search term to filter results
+}
+
+begin
+  # Get a list of all storage engines
+  result = api_instance.list_storage_engines(provider_id, opts)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->list_storage_engines: #{e}"
+end
+```
+
+#### Using the list_storage_engines_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListStorageEngines200Response>, Integer, Hash)> list_storage_engines_with_http_info(provider_id, opts)
+
+```ruby
+begin
+  # Get a list of all storage engines
+  data, status_code, headers = api_instance.list_storage_engines_with_http_info(provider_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListStorageEngines200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->list_storage_engines_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_id** | **String** | Unique identifier for the Provider |  |
+| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
+| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
+| **sort_by** | **String** | Field to sort by | [optional] |
+| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to &#39;desc&#39;] |
+| **search** | **String** | Search term to filter results | [optional] |
+
+### Return type
+
+[**ListStorageEngines200Response**](ListStorageEngines200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UpdateAlerts200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateAlerts200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateAlerts200ResponseData**](UpdateAlerts200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAlerts200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateAlerts200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateAlerts200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alert_id** | **String** | ID of the updated alerts |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAlerts200ResponseData.new(
+  alert_id: null
+)
+```
+

data/docs/UpdateApiKeys200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateApiKeys200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateApiKeys200ResponseData**](UpdateApiKeys200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateApiKeys200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateApiKeys200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateApiKeys200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_id** | **String** | ID of the updated api_keys |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateApiKeys200ResponseData.new(
+  api_key_id: null
+)
+```
+

data/docs/UpdateAssetPriceHistory200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateAssetPriceHistory200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateAssetPriceHistory200ResponseData**](UpdateAssetPriceHistory200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAssetPriceHistory200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateAssetPriceHistory200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateAssetPriceHistory200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aph_id** | **String** | ID of the updated asset_price_history |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAssetPriceHistory200ResponseData.new(
+  aph_id: null
+)
+```
+

data/docs/UpdateAssets200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateAssets200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateAssets200ResponseData**](UpdateAssets200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAssets200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateAssets200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateAssets200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asset_id** | **String** | ID of the updated assets |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateAssets200ResponseData.new(
+  asset_id: null
+)
+```
+

data/docs/UpdateCompanies200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateCompanies200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateCompanies200ResponseData**](UpdateCompanies200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateCompanies200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateCompanies200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateCompanies200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** | ID of the updated companies |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateCompanies200ResponseData.new(
+  company_id: null
+)
+```
+

data/docs/UpdateConnections200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateConnections200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateConnections200ResponseData**](UpdateConnections200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateConnections200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateConnections200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateConnections200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** | ID of the updated connections |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateConnections200ResponseData.new(
+  connection_id: null
+)
+```
+

data/docs/UpdateEndpoints200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateEndpoints200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateEndpoints200ResponseData**](UpdateEndpoints200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateEndpoints200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateEndpoints200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateEndpoints200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** | ID of the updated endpoints |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateEndpoints200ResponseData.new(
+  endpoint_id: null
+)
+```
+

data/docs/UpdateFavorites200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdateFavorites200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdateFavorites200ResponseData**](UpdateFavorites200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateFavorites200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdateFavorites200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdateFavorites200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **favorite_id** | **String** | ID of the updated favorites |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdateFavorites200ResponseData.new(
+  favorite_id: null
+)
+```
+

data/docs/UpdatePostgenIntegrations200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::UpdatePostgenIntegrations200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**UpdatePostgenIntegrations200ResponseData**](UpdatePostgenIntegrations200ResponseData.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdatePostgenIntegrations200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/UpdatePostgenIntegrations200ResponseData.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::UpdatePostgenIntegrations200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_id** | **String** | ID of the updated postgen_integrations |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UpdatePostgenIntegrations200ResponseData.new(
+  integration_id: null
+)
+```
+