spartera_api_sdk 0.4.2 → 1.0.58

data/README.md

@@ -1,372 +1,360 @@
-# spartera_api_sdk
+# Ruby SDK Documentation
 
-SparteraApiSdk - the Ruby gem for the Spartera API Documentation
+## Overview
+The Ruby SDK for Spartera API provides a convenient way to interact with the Spartera platform from Ruby applications.
 
-Auto-generated API documentation for REST services of the Spartera platform
+**Install:** `gem install spartera_api_sdk`
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Requirements
+- Ruby 2.7 or higher
+- Bundler
 
-- API version: 1.25.0
-- Package version: 0.4.2
-- Generator version: 7.21.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+## 🚀 Sell Your First Data Product in 4 API Calls
 
-## Installation
+Transform your data into revenue in under 5 minutes! Here's how to create and sell a data product on the Spartera marketplace:
 
-### Build a gem
+```ruby
+require 'spartera_api_sdk'
+require 'json'
 
-To build the Ruby code into a gem:
+# Configure client
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = 'your-api-key-here'
+end
+
+COMPANY_ID = 'your-company-id'
+USER_ID = 'your-user-id'
+
+def sell_data_product
+  # Step 1: Discover available data platforms
+  puts '🔍 Step 1: Discovering available platforms...'
+  cloud_providers_api = SparteraApiSdk::CloudProvidersApi.new
+  
+  engines = cloud_providers_api.cloud_providers_get
+  bigquery_engine_id = 1  # BigQuery engine ID
+  puts "✅ Found #{engines.length} supported platforms"
+
+  # Step 2: Create a data connection (with credentials in one call!)
+  puts '🔗 Step 2: Creating BigQuery connection...'
+  connections_api = SparteraApiSdk::ConnectionsApi.new
+  
+  # Your BigQuery service account JSON (replace with your actual credentials)
+  service_account_json = {
+    type: 'service_account',
+    project_id: 'your-project-id',
+    private_key_id: 'key-id',
+    private_key: "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n",
+    client_email: 'your-service@your-project.iam.gserviceaccount.com',
+    client_id: 'client-id',
+    auth_uri: 'https://accounts.google.com/o/oauth2/auth',
+    token_uri: 'https://oauth2.googleapis.com/token'
+  }
+
+  connection_data = SparteraApiSdk::Connection.new(
+    company_id: COMPANY_ID,
+    user_id: USER_ID,
+    engine_id: bigquery_engine_id,
+    name: 'My BigQuery Data Warehouse',
+    description: "Connection to our company's analytics data",
+    visibility: 'PRIVATE',
+    credential_type: 'SERVICE_ACCOUNT',
+    credentials: service_account_json.to_json,
+    verified_usage_ability: true  # Legal compliance - you have rights to this data
+  )
+
+  connection = connections_api.companies_company_id_connections_post(COMPANY_ID, connection_data)
+  connection_id = connection.connection_id
+  puts "✅ Created connection: #{connection_id}"
+
+  # Step 3: Create a marketplace asset
+  puts '📊 Step 3: Creating marketplace asset...'
+  assets_api = SparteraApiSdk::AssetsApi.new
+
+  asset_data = SparteraApiSdk::Asset.new(
+    name: 'Average Temperature Analytics',
+    description: 'Real-time weather temperature analytics from our IoT sensors across major cities',
+    company_id: COMPANY_ID,
+    connection_id: connection_id,
+    asset_type: 'CALCULATION',
+    sql_logic: 'SELECT AVERAGE(temperature) AS avg_temp, city, COUNT(*) AS readings FROM `your-project.weather.sensor_data` WHERE timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 24 HOUR) GROUP BY city ORDER BY avg_temp DESC',
+    sell_in_marketplace: true,  # 🔥 This makes it available for purchase!
+    source: 'MANUAL',
+    visibility: 'PUBLIC'
+  )
+
+  asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
+  asset_id = asset.asset_id
+  puts "✅ Created marketplace asset: #{asset_id}"
+
+  # Step 4: Set your price and start earning!
+  puts '💰 Step 4: Setting price...'
+  pricing_api = SparteraApiSdk::AssetPriceHistoryApi.new
+
+  price_data = SparteraApiSdk::Assetpricehistory.new(
+    price_usd: 2.00  # $2.00 per analysis (credits calculated automatically)
+  )
+
+  price = pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, price_data)
+  puts "✅ Price set: $#{price.price_usd} (≈#{price.price_credits} credits)"
+
+  puts "\n🎉 SUCCESS! Your data product is now live on the Spartera marketplace!"
+  puts "📈 Asset URL: https://marketplace.spartera.com/assets/#{asset_id}"
+  puts '💡 Customers can now discover and purchase your analytics!'
+rescue SparteraApiSdk::ApiError => e
+  puts "Error: #{e.message}"
+  raise e
+end
 
-```shell
-gem build spartera_api_sdk.gemspec
+# Run the function
+sell_data_product
 ```
 
-Then either install the gem locally:
+**That's it!** You're now selling data analytics. Every time someone runs your analysis, you earn money! 
 
-```shell
-gem install ./spartera_api_sdk-0.4.2.gem
-```
+### 🎯 What You Just Built
+- **Data Connection**: Secure link to your BigQuery warehouse
+- **Analytics Product**: Temperature analysis that buyers can purchase
+- **Marketplace Listing**: Your product is discoverable by thousands of potential customers
+- **Automated Pricing**: Credits are calculated automatically based on your USD price
+
+### 💰 Revenue Model
+- You set the price ($2.00 in this example)
+- Customers pay in credits (auto-converted)
+- You earn revenue each time someone uses your analytics
+- Spartera handles billing, payments, and customer support
 
-(for development, run `gem install --dev ./spartera_api_sdk-0.4.2.gem` to install the development dependencies)
+---
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+## 📚 Detailed Documentation
 
-Finally add this to the Gemfile:
+### Authentication
 
-    gem 'spartera_api_sdk', '~> 0.4.2'
+Get your API key from the [Spartera Dashboard](https://app.spartera.com/settings/api-keys):
 
-### Install from Git
+```ruby
+require 'spartera_api_sdk'
+
+# Option 1: Direct configuration
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = 'your-api-key-here'
+end
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+# Option 2: Environment variables (recommended)
+ENV['SPARTERA_API_KEY'] = 'your-api-key'
+ENV['SPARTERA_COMPANY_ID'] = 'your-company-id'
 
-    gem 'spartera_api_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+SparteraApiSdk.configure do |config|
+  config.host = 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = ENV['SPARTERA_API_KEY']
+end
 
-### Include the Ruby code directly
+# Create API instances
+companies_api = SparteraApiSdk::CompaniesApi.new
+assets_api = SparteraApiSdk::AssetsApi.new
+```
 
-Include the Ruby code directly using `-I` as follows:
+### Environment Variables
 
-```shell
-ruby -Ilib script.rb
+```bash
+export SPARTERA_API_KEY="your-api-key"
+export SPARTERA_COMPANY_ID="your-company-id"
+export SPARTERA_API_BASE_URL="https://api.spartera.com"
 ```
 
-## Getting Started
+### Connection Types
 
-Please follow the [installation](#installation) procedure and then run the following code:
+Create connections to different data platforms:
 
 ```ruby
-# Load the gem
-require 'spartera_api_sdk'
+# BigQuery
+bigquery_credentials = {
+  type: 'service_account',
+  project_id: 'your-project',
+  # ... your service account JSON
+}
 
-# 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
+# Snowflake
+snowflake_connection = SparteraApiSdk::Connection.new(
+  credential_type: 'USERNAME_PASSWORD',
+  username: 'your-username',
+  password: 'your-password'
+)
+
+# API Data Source
+api_connection = SparteraApiSdk::Connection.new(
+  credential_type: 'API_KEY',
+  api_endpoint: 'https://api.yourcompany.com/data',
+  api_key_param: 'x-api-key',
+  credentials: 'your-api-key-value'
+)
+```
 
-api_instance = SparteraApiSdk::APIKeysApi.new
-company_id = 'company_id_example' # String | Unique identifier for the Company
-api_keys_input = SparteraApiSdk::ApiKeysInput.new({company_id: 'company_id_abc123', role_id: 1}) # ApiKeysInput | 
-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
-}
+### Asset Types
+
+Create different types of marketplace products:
+
+```ruby
+# SQL-based Analytics
+calculation_asset = SparteraApiSdk::Asset.new(
+  asset_type: 'CALCULATION',
+  sql_logic: 'SELECT COUNT(*) as total_sales, AVG(amount) as avg_order FROM sales WHERE date >= CURRENT_DATE()'
+)
+
+# Visualization/Dashboard
+visualization_asset = SparteraApiSdk::Asset.new(
+  asset_type: 'VISUALIZATION',
+  viz_chart_type: 'BAR',
+  viz_dep_var_col_name: 'sales_amount',
+  viz_indep_var_col_name: 'month'
+)
+```
+
+### Pricing Strategies
 
+Set different pricing models:
+
+```ruby
+# Fixed price per analysis
+basic_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 1.50)
+
+# Premium analytics
+premium_pricing = SparteraApiSdk::Assetpricehistory.new(price_usd: 10.00)
+
+# Bulk discount with sales
+sale_pricing = SparteraApiSdk::Assetpricehistory.new(
+  price_usd: 5.00,
+  discount_percentage: 20.0,
+  sale_start_date: '2024-01-01T00:00:00Z',
+  sale_end_date: '2024-01-31T23:59:59Z'
+)
+```
+
+### Marketplace Management
+
+Manage your products after launch:
+
+```ruby
+# Update asset details
+update_data = SparteraApiSdk::Asset.new(
+  description: 'Updated description with new features'
+)
+assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, update_data)
+
+# Change pricing
+new_price = SparteraApiSdk::Assetpricehistory.new(price_usd: 3.00)
+pricing_api.companies_company_id_assets_asset_id_prices_post(COMPANY_ID, asset_id, new_price)
+
+# Remove from marketplace (but keep private)
+marketplace_update = SparteraApiSdk::Asset.new(sell_in_marketplace: false)
+assets_api.companies_company_id_assets_asset_id_patch(COMPANY_ID, asset_id, marketplace_update)
+
+# Get sales analytics
+analytics = companies_api.companies_company_id_analytics_sales_get(COMPANY_ID)
+puts "Total revenue: $#{analytics.total_revenue}"
+```
+
+### Error Handling
+
+```ruby
 begin
-  #Create single API key.     Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
-  result = api_instance.create_api_keys(company_id, api_keys_input, opts)
-  p result
+  asset = assets_api.companies_company_id_assets_post(COMPANY_ID, asset_data)
 rescue SparteraApiSdk::ApiError => e
-  puts "Exception when calling APIKeysApi->create_api_keys: #{e}"
+  puts "API Error: #{e.message}"
+  puts "Status: #{e.code}"
+  puts "Response: #{e.response_body}"
+  
+  # Handle specific errors
+  case e.code
+  when 400
+    puts 'Check your asset data format'
+  when 401
+    puts 'Check your API key'
+  when 403
+    puts 'Check your permissions'
+  when 404
+    puts 'Check your IDs'
+  else
+    puts "HTTP #{e.code}: #{e.message}"
+  end
+  
+  raise e
+end
+```
+
+### Advanced Features
+
+```ruby
+# Batch operations
+connection_ids = []
+%w[bigquery snowflake redshift].each do |platform|
+  conn = connections_api.companies_company_id_connections_post(COMPANY_ID, platform_config)
+  connection_ids << conn.connection_id
+end
+
+# Asset recommendations
+recommendations = assets_api.companies_company_id_assets_asset_id_recommendations_get(
+  COMPANY_ID, 
+  asset_id, 
+  { limit: 10 }
+)
+
+# Performance analytics
+performance = companies_api.companies_company_id_analytics_assets_get(
+  COMPANY_ID,
+  start_date: '2024-01-01',
+  end_date: '2024-12-31'
+)
+```
+
+### Rails Integration
+
+For Ruby on Rails applications:
+
+```ruby
+# Gemfile
+gem 'spartera_api_sdk'
+
+# config/initializers/spartera.rb
+SparteraApiSdk.configure do |config|
+  config.host = Rails.application.credentials.spartera[:api_url] || 'https://api.spartera.com'
+  config.api_key['X-API-Key'] = Rails.application.credentials.spartera[:api_key]
 end
 
+# app/services/spartera_service.rb
+class SparteraService
+  def self.companies_api
+    @companies_api ||= SparteraApiSdk::CompaniesApi.new
+  end
+  
+  def self.assets_api
+    @assets_api ||= SparteraApiSdk::AssetsApi.new
+  end
+  
+  def self.get_company(company_id)
+    companies_api.companies_company_id_get(company_id)
+  rescue SparteraApiSdk::ApiError => e
+    Rails.logger.error "Spartera API Error: #{e.message}"
+    nil
+  end
+end
+
+# Usage in controllers
+class AssetsController < ApplicationController
+  def show
+    @company = SparteraService.get_company(params[:company_id])
+    # ...
+  end
+end
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://api.spartera.com*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*SparteraApiSdk::APIKeysApi* | [**create_api_keys**](docs/APIKeysApi.md#create_api_keys) | **POST** /companies/{company_id}/api-keys | Create single API key.     Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
-*SparteraApiSdk::APIKeysApi* | [**create_api_keys_api_keys_revoke**](docs/APIKeysApi.md#create_api_keys_api_keys_revoke) | **POST** /companies/{company_id}/api-keys/{api_key_id}/revoke | Explicitly revoke an API key with reason tracking.     This is different from delete as it includes revocation metadata.
-*SparteraApiSdk::APIKeysApi* | [**delete_api_keys**](docs/APIKeysApi.md#delete_api_keys) | **DELETE** /companies/{company_id}/api-keys/{api_key_id} | Delete (deactivate) single API key by api_key_id.     Uses the api_key_id returned during creation for clean identification.     Fixed to use correct primary key lookup.
-*SparteraApiSdk::APIKeysApi* | [**get_api_keys_by_id**](docs/APIKeysApi.md#get_api_keys_by_id) | **GET** /companies/{company_id}/api-keys/{api_key_id} | Get single API key by ID.     Returns masked API key for security (sk_****1234).
-*SparteraApiSdk::APIKeysApi* | [**get_api_keys_by_id_api_keys_stats**](docs/APIKeysApi.md#get_api_keys_by_id_api_keys_stats) | **GET** /companies/{company_id}/api-keys/{api_key_id}/stats | Get usage statistics for a specific API key.     Returns usage count, last used date, failed attempts, etc.
-*SparteraApiSdk::APIKeysApi* | [**list_api_keys**](docs/APIKeysApi.md#list_api_keys) | **GET** /companies/{company_id}/api-keys | Get all API keys for a company.     Returns masked API keys for security (sk_****1234).
-*SparteraApiSdk::APIKeysApi* | [**update_api_keys**](docs/APIKeysApi.md#update_api_keys) | **PATCH** /companies/{company_id}/api-keys/{api_key_id} | Update an existing API key by ID.     Can update metadata like name, expiration, rate limits, etc.     Cannot update the actual key value (for security).
-*SparteraApiSdk::AlertsApi* | [**create_alerts**](docs/AlertsApi.md#create_alerts) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts
-*SparteraApiSdk::AlertsApi* | [**delete_alerts**](docs/AlertsApi.md#delete_alerts) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID
-*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id**](docs/AlertsApi.md#get_alerts_by_id) | **GET** /companies/{company_id}/users/{user_id}/alerts | Get a list of all alerts for a specific user
-*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_asset_all**](docs/AlertsApi.md#get_alerts_by_id_asset_all) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset
-*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_users**](docs/AlertsApi.md#get_alerts_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Get single alert by ID
-*SparteraApiSdk::AlertsApi* | [**get_alerts_by_id_users_asset**](docs/AlertsApi.md#get_alerts_by_id_users_asset) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset (by user)
-*SparteraApiSdk::AlertsApi* | [**update_alerts**](docs/AlertsApi.md#update_alerts) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID
-*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history**](docs/AssetPriceHistoryApi.md#create_asset_price_history) | **POST** /companies/{company_id}/assets/{asset_id}/prices | Create a new price history record for an asset
-*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history_prices_calculate_credits**](docs/AssetPriceHistoryApi.md#create_asset_price_history_prices_calculate_credits) | **POST** /companies/{company_id}/assets/{asset_id}/prices/calculate_credits | Calculate the credit equivalent for a given USD price without saving
-*SparteraApiSdk::AssetPriceHistoryApi* | [**create_asset_price_history_prices_discount**](docs/AssetPriceHistoryApi.md#create_asset_price_history_prices_discount) | **POST** /companies/{company_id}/assets/{asset_id}/prices/discount | POST /companies/{company_id}/assets/{asset_id}/prices/discount
-*SparteraApiSdk::AssetPriceHistoryApi* | [**delete_asset_price_history**](docs/AssetPriceHistoryApi.md#delete_asset_price_history) | **DELETE** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Delete single price history record by ID
-*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id) | **GET** /companies/{company_id}/assets/{asset_id}/prices | Get all price history records for a specific asset
-*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id_assets_prices**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id_assets_prices) | **GET** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Get single price history record by ID
-*SparteraApiSdk::AssetPriceHistoryApi* | [**get_asset_price_history_by_id_prices_active**](docs/AssetPriceHistoryApi.md#get_asset_price_history_by_id_prices_active) | **GET** /companies/{company_id}/assets/{asset_id}/prices/active | Get the currently active price for an asset
-*SparteraApiSdk::AssetPriceHistoryApi* | [**update_asset_price_history**](docs/AssetPriceHistoryApi.md#update_asset_price_history) | **PATCH** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Update an existing price history record by ID
-*SparteraApiSdk::AssetUsecasesApi* | [**get_asset_usecases_by_id**](docs/AssetUsecasesApi.md#get_asset_usecases_by_id) | **GET** /asset_usecases/{auc_id} | Get single asset use case by ID
-*SparteraApiSdk::AssetUsecasesApi* | [**list_asset_usecases**](docs/AssetUsecasesApi.md#list_asset_usecases) | **GET** /asset_usecases | Get a list of all asset use cases
-*SparteraApiSdk::AssetsApi* | [**create_assets**](docs/AssetsApi.md#create_assets) | **POST** /companies/{company_id}/assets | Create a new asset
-*SparteraApiSdk::AssetsApi* | [**create_assets_analyze**](docs/AssetsApi.md#create_assets_analyze) | **POST** /analyze/{company_handle}/assets/{asset_slug} | Process (analyze) an asset with dynamic rate limiting applied via decorator.
-*SparteraApiSdk::AssetsApi* | [**create_assets_scan_column**](docs/AssetsApi.md#create_assets_scan_column) | **POST** /companies/{company_id}/assets/{asset_id}/scan_column | Scan a column in the asset's table to retrieve distinct values      Request Body:         column (str): Column name to scan         limit (int, optional): Maximum distinct values to return (default 1000, max 5000)      Returns:         Flask Response with scan results
-*SparteraApiSdk::AssetsApi* | [**create_assets_test**](docs/AssetsApi.md#create_assets_test) | **POST** /companies/{company_id}/assets/{asset_id}/test | POST /companies/{company_id}/assets/{asset_id}/test
-*SparteraApiSdk::AssetsApi* | [**delete_assets**](docs/AssetsApi.md#delete_assets) | **DELETE** /companies/{company_id}/assets/{asset_id} | Delete single asset by ID
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id**](docs/AssetsApi.md#get_assets_by_id) | **GET** /companies/{company_id}/assets/{asset_id} | Get single asset by ID
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id2**](docs/AssetsApi.md#get_assets_by_id2) | **GET** /companies/{company_id}/assets/{asset_id}/statistics | Get statistics for a specific asset (public endpoint)
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_analyze**](docs/AssetsApi.md#get_assets_by_id_analyze) | **GET** /analyze/{company_handle}/assets/{asset_slug} | Process (analyze) an asset with dynamic rate limiting applied via decorator.
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_infoschema**](docs/AssetsApi.md#get_assets_by_id_infoschema) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema | Get the information schema for a specific asset's table
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_infoschema_save**](docs/AssetsApi.md#get_assets_by_id_infoschema_save) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema/save | Retrieve and save an asset's information schema
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_predicted_price**](docs/AssetsApi.md#get_assets_by_id_predicted_price) | **GET** /companies/{company_id}/assets/{asset_id}/predicted_price | Get AI-predicted pricing for a specific asset
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_statistics**](docs/AssetsApi.md#get_assets_by_id_statistics) | **GET** /companies/{company_id}/assets/statistics | Get statistics for all assets the user has access to
-*SparteraApiSdk::AssetsApi* | [**get_assets_by_id_test**](docs/AssetsApi.md#get_assets_by_id_test) | **GET** /companies/{company_id}/assets/{asset_id}/test | GET /companies/{company_id}/assets/{asset_id}/test
-*SparteraApiSdk::AssetsApi* | [**list_assets**](docs/AssetsApi.md#list_assets) | **GET** /companies/{company_id}/assets | Get all assets for a specific company
-*SparteraApiSdk::AssetsApi* | [**list_assets_search**](docs/AssetsApi.md#list_assets_search) | **GET** /companies/{company_id}/assets/search | Search and filter assets with advanced options      Query Parameters:         q: Search query string         category: Filter by category         sport: Filter by sport tag         sort_by: Sort field (name|recent|popular|trending)         limit: Number of results (default 20, max 100)         offset: Offset for pagination         include_recommended: Include recommendations (true/false)         include_schema: Include asset_schema in response (true/false, default false)
-*SparteraApiSdk::AssetsApi* | [**update_assets**](docs/AssetsApi.md#update_assets) | **PATCH** /companies/{company_id}/assets/{asset_id} | Update an existing asset by ID
-*SparteraApiSdk::CloudProvidersApi* | [**get_cloud_providers_by_id**](docs/CloudProvidersApi.md#get_cloud_providers_by_id) | **GET** /cloud-providers/{provider_id} | Get single cloud provider by ID
-*SparteraApiSdk::CloudProvidersApi* | [**list_cloud_providers**](docs/CloudProvidersApi.md#list_cloud_providers) | **GET** /cloud-providers | Get a list of all cloud providers
-*SparteraApiSdk::CompaniesApi* | [**get_companies_by_id**](docs/CompaniesApi.md#get_companies_by_id) | **GET** /companies/{company_id} | Get details of the requestor's own company
-*SparteraApiSdk::CompaniesApi* | [**list_companies**](docs/CompaniesApi.md#list_companies) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company's current subscription plan.
-*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_assets**](docs/CompaniesApi.md#list_companies_analytics_assets) | **GET** /companies/{company_id}/analytics/assets | Get asset performance analytics.     Query params: start_date, end_date, limit, sort_by, include
-*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_customers**](docs/CompaniesApi.md#list_companies_analytics_customers) | **GET** /companies/{company_id}/analytics/customers | Get customer analytics including growth and segmentation.     Query params: start_date, end_date, group_by, segment_by
-*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_dashboard**](docs/CompaniesApi.md#list_companies_analytics_dashboard) | **GET** /companies/{company_id}/analytics/dashboard | Get comprehensive dashboard analytics for seller dashboard.     Query params: start_date, end_date, period (day/week/month/quarter)
-*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_metrics**](docs/CompaniesApi.md#list_companies_analytics_metrics) | **GET** /companies/{company_id}/analytics/metrics | Get summary metrics (counts only). No date params needed — returns all-time totals.     Performance: < 0.1s
-*SparteraApiSdk::CompaniesApi* | [**list_companies_analytics_sales**](docs/CompaniesApi.md#list_companies_analytics_sales) | **GET** /companies/{company_id}/analytics/sales | Get sales over time analytics.     Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
-*SparteraApiSdk::CompaniesApi* | [**list_companies_objects**](docs/CompaniesApi.md#list_companies_objects) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company
-*SparteraApiSdk::CompaniesApi* | [**list_companies_requests_usage**](docs/CompaniesApi.md#list_companies_requests_usage) | **GET** /companies/{company_id}/requests/usage | Get company request usage data for a specific month.
-*SparteraApiSdk::CompaniesApi* | [**update_companies**](docs/CompaniesApi.md#update_companies) | **PATCH** /companies/{company_id} | Update an existing company by ID
-*SparteraApiSdk::ConnectionsApi* | [**create_connections**](docs/ConnectionsApi.md#create_connections) | **POST** /companies/{company_id}/connections | Create a new connection by ID
-*SparteraApiSdk::ConnectionsApi* | [**delete_connections**](docs/ConnectionsApi.md#delete_connections) | **DELETE** /companies/{company_id}/connections/{connection_id} | Delete single connection by ID
-*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id**](docs/ConnectionsApi.md#get_connections_by_id) | **GET** /companies/{company_id}/connections/{connection_id} | Get single connection by ID
-*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id2**](docs/ConnectionsApi.md#get_connections_by_id2) | **GET** /companies/{company_id}/connections/{connection_id}/test | Test the specified connection
-*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id_infoschema**](docs/ConnectionsApi.md#get_connections_by_id_infoschema) | **GET** /companies/{company_id}/connections/{connection_id}/infoschema | Retrieve the information schema for the specified connection
-*SparteraApiSdk::ConnectionsApi* | [**get_connections_by_id_sample_data**](docs/ConnectionsApi.md#get_connections_by_id_sample_data) | **GET** /companies/{company_id}/connections/{connection_id}/sample-data | Get a randomized sample of rows from a table on this connection.     Used by the visualization editor to give sellers data to author against.      Query Parameters:         schema_name (required): Schema/dataset name         table_name  (required): Table name         limit       (optional): Max rows to return (default 1000, max 10000)      Returns columnar data — {column_name: [values]} — ready for Plotly's     dataSources prop. The actual chart at render time will pull fresh data     via the asset's saved SQL; this is only for authoring preview.
-*SparteraApiSdk::ConnectionsApi* | [**list_connections**](docs/ConnectionsApi.md#list_connections) | **GET** /companies/{company_id}/connections | Get all connections for a specific company
-*SparteraApiSdk::ConnectionsApi* | [**update_connections**](docs/ConnectionsApi.md#update_connections) | **PATCH** /companies/{company_id}/connections/{connection_id} | Update an existing connection by ID
-*SparteraApiSdk::EndpointsApi* | [**create_endpoints**](docs/EndpointsApi.md#create_endpoints) | **POST** /companies/{company_id}/endpoints | Create a new endpoint
-*SparteraApiSdk::EndpointsApi* | [**create_endpoints_keys**](docs/EndpointsApi.md#create_endpoints_keys) | **POST** /companies/{company_id}/endpoints/{endpoint_id}/keys | POST /companies/{company_id}/endpoints/{endpoint_id}/keys
-*SparteraApiSdk::EndpointsApi* | [**create_endpoints_scan_column**](docs/EndpointsApi.md#create_endpoints_scan_column) | **POST** /companies/{company_id}/endpoints/{endpoint_id}/scan_column | POST /companies/{company_id}/endpoints/{endpoint_id}/scan_column
-*SparteraApiSdk::EndpointsApi* | [**delete_endpoints**](docs/EndpointsApi.md#delete_endpoints) | **DELETE** /companies/{company_id}/endpoints/{endpoint_id} | Delete single endpoint by ID
-*SparteraApiSdk::EndpointsApi* | [**delete_endpoints_keys**](docs/EndpointsApi.md#delete_endpoints_keys) | **DELETE** /companies/{company_id}/endpoints/{endpoint_id}/keys/{api_key_id} | DELETE /companies/{company_id}/endpoints/{endpoint_id}/keys/{api_key_id}
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id**](docs/EndpointsApi.md#get_endpoints_by_id) | **GET** /companies/{company_id}/endpoints/{endpoint_id} | Get single endpoint by ID
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_available_endpoints**](docs/EndpointsApi.md#get_endpoints_by_id_available_endpoints) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/available-endpoints | GET /companies/{company_id}/endpoints/{endpoint_id}/available-endpoints
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_connections_describe**](docs/EndpointsApi.md#get_endpoints_by_id_connections_describe) | **GET** /companies/{company_id}/endpoints/../connections/{connection_id}/describe | Get schema information for a connection      Query parameters:         include_fields: Whether to include field information (default: true)         schemas: Optional comma-separated schemas to include         tables: Optional comma-separated tables to include
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_execute**](docs/EndpointsApi.md#get_endpoints_by_id_execute) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/execute | Execute an endpoint with pagination support.      Customer-facing route that returns paginated data.     Query params: ?start=0&limit=100
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_keys**](docs/EndpointsApi.md#get_endpoints_by_id_keys) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/keys | GET /companies/{company_id}/endpoints/{endpoint_id}/keys
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_recommendations**](docs/EndpointsApi.md#get_endpoints_by_id_recommendations) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/recommendations | GET /companies/{company_id}/endpoints/{endpoint_id}/recommendations
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_stats**](docs/EndpointsApi.md#get_endpoints_by_id_stats) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/stats | Get usage statistics for an endpoint      Query parameters:         days: Number of days to analyze (default: 30)
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_test**](docs/EndpointsApi.md#get_endpoints_by_id_test) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/test | Test an endpoint with sample data      Request body (optional):         limit: Number of sample rows to return (default: 10)
-*SparteraApiSdk::EndpointsApi* | [**get_endpoints_by_id_url**](docs/EndpointsApi.md#get_endpoints_by_id_url) | **GET** /companies/{company_id}/endpoints/{endpoint_id}/url | GET /companies/{company_id}/endpoints/{endpoint_id}/url
-*SparteraApiSdk::EndpointsApi* | [**list_endpoints**](docs/EndpointsApi.md#list_endpoints) | **GET** /companies/{company_id}/endpoints | Get all endpoints for a specific company with pagination, filtering, and sorting
-*SparteraApiSdk::EndpointsApi* | [**update_endpoints**](docs/EndpointsApi.md#update_endpoints) | **PATCH** /companies/{company_id}/endpoints/{endpoint_id} | Update an existing endpoint by ID
-*SparteraApiSdk::FavoritesApi* | [**create_favorites**](docs/FavoritesApi.md#create_favorites) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites
-*SparteraApiSdk::FavoritesApi* | [**delete_favorites**](docs/FavoritesApi.md#delete_favorites) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset)
-*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id**](docs/FavoritesApi.md#get_favorites_by_id) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user
-*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users**](docs/FavoritesApi.md#get_favorites_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID
-*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_category**](docs/FavoritesApi.md#get_favorites_by_id_users_category) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category
-*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_check**](docs/FavoritesApi.md#get_favorites_by_id_users_check) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset
-*SparteraApiSdk::FavoritesApi* | [**get_favorites_by_id_users_uncategorized**](docs/FavoritesApi.md#get_favorites_by_id_users_uncategorized) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category
-*SparteraApiSdk::FavoritesApi* | [**update_favorites**](docs/FavoritesApi.md#update_favorites) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID
-*SparteraApiSdk::IndustriesApi* | [**get_industries_by_id**](docs/IndustriesApi.md#get_industries_by_id) | **GET** /industries/{industry_id} | Get single industry by ID
-*SparteraApiSdk::IndustriesApi* | [**list_industries**](docs/IndustriesApi.md#list_industries) | **GET** /industries | Get a list of all industries
-*SparteraApiSdk::IndustriesApi* | [**list_industries_active**](docs/IndustriesApi.md#list_industries_active) | **GET** /industries/active | Get a list of industries that have active marketplace products
-*SparteraApiSdk::JobFunctionsApi* | [**get_job_functions_by_id**](docs/JobFunctionsApi.md#get_job_functions_by_id) | **GET** /job-functions/{function_id} | Get single job function by ID
-*SparteraApiSdk::JobFunctionsApi* | [**list_job_functions**](docs/JobFunctionsApi.md#list_job_functions) | **GET** /job-functions | Get a list of all job functions
-*SparteraApiSdk::PostgenIntegrationsApi* | [**create_postgen_integrations**](docs/PostgenIntegrationsApi.md#create_postgen_integrations) | **POST** /companies/{company_id}/postgen_integrations | POST /companies/{company_id}/postgen_integrations
-*SparteraApiSdk::PostgenIntegrationsApi* | [**create_postgen_integrations_test**](docs/PostgenIntegrationsApi.md#create_postgen_integrations_test) | **POST** /companies/{company_id}/postgen_integrations/test | POST /companies/{company_id}/postgen_integrations/test
-*SparteraApiSdk::PostgenIntegrationsApi* | [**delete_postgen_integrations**](docs/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.
-*SparteraApiSdk::PostgenIntegrationsApi* | [**get_postgen_integrations_by_id**](docs/PostgenIntegrationsApi.md#get_postgen_integrations_by_id) | **GET** /companies/{company_id}/postgen_integrations/{integration_id} | Get single integration by ID.
-*SparteraApiSdk::PostgenIntegrationsApi* | [**list_postgen_integrations**](docs/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.
-*SparteraApiSdk::PostgenIntegrationsApi* | [**update_postgen_integrations**](docs/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.
-*SparteraApiSdk::PostsApi* | [**create_posts**](docs/PostsApi.md#create_posts) | **POST** /companies/{company_id}/posts | POST /companies/{company_id}/posts
-*SparteraApiSdk::PostsApi* | [**create_posts2**](docs/PostsApi.md#create_posts2) | **POST** /companies/{company_id}/posts/{post_id}/publish/{integration_id} | Publish a post to an external platform via an integration.      Args:         post_id: ID of the post to publish         integration_id: ID of the integration to use (from postgen_integrations)      Returns:         Publication record with external_url and external_post_id
-*SparteraApiSdk::PostsApi* | [**create_posts_publish**](docs/PostsApi.md#create_posts_publish) | **POST** /companies/{company_id}/posts/{post_id}/publish | Publish a post (make it publicly visible).
-*SparteraApiSdk::PostsApi* | [**create_posts_unpublish**](docs/PostsApi.md#create_posts_unpublish) | **POST** /companies/{company_id}/posts/{post_id}/unpublish | Unpublish a post (make it private/draft again).
-*SparteraApiSdk::PostsApi* | [**create_posts_view**](docs/PostsApi.md#create_posts_view) | **POST** /companies/{company_id}/posts/{post_id}/view | Increment view count for a post.     Public endpoint (no authentication required).
-*SparteraApiSdk::PostsApi* | [**delete_posts**](docs/PostsApi.md#delete_posts) | **DELETE** /companies/{company_id}/posts/{post_id} | Delete single post by ID.
-*SparteraApiSdk::PostsApi* | [**get_posts_by_id**](docs/PostsApi.md#get_posts_by_id) | **GET** /companies/{company_id}/posts/{post_id} | Get single post by ID.
-*SparteraApiSdk::PostsApi* | [**get_posts_by_id_publications**](docs/PostsApi.md#get_posts_by_id_publications) | **GET** /companies/{company_id}/posts/{post_id}/publications | Get all publications for a post.     Shows where this post has been published to external platforms.      Returns:         Array of publication records with platform, URL, status
-*SparteraApiSdk::PostsApi* | [**list_posts**](docs/PostsApi.md#list_posts) | **GET** /companies/{company_id}/posts | Get a list of all posts for the user's company.     Supports filtering, sorting, pagination.
-*SparteraApiSdk::PostsApi* | [**list_posts_summary**](docs/PostsApi.md#list_posts_summary) | **GET** /companies/{company_id}/posts/summary | GET /companies/{company_id}/posts/summary
-*SparteraApiSdk::PostsApi* | [**update_posts**](docs/PostsApi.md#update_posts) | **PATCH** /companies/{company_id}/posts/{post_id} | Update an existing post by ID.      Note: last_edited_at is automatically updated.
-*SparteraApiSdk::StorageEnginesApi* | [**get_storage_engines_by_id**](docs/StorageEnginesApi.md#get_storage_engines_by_id) | **GET** /cloud-providers/{provider_id}/storage-engines/{engine_id} | Get single storage engine by ID
-*SparteraApiSdk::StorageEnginesApi* | [**list_storage_engines**](docs/StorageEnginesApi.md#list_storage_engines) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines
-*SparteraApiSdk::UsersApi* | [**create_users**](docs/UsersApi.md#create_users) | **POST** /companies/{company_id}/users | Create a new user
-*SparteraApiSdk::UsersApi* | [**create_users_google_oauth**](docs/UsersApi.md#create_users_google_oauth) | **POST** /companies/{company_id}/users/google-oauth | POST /companies/{company_id}/users/google-oauth
-*SparteraApiSdk::UsersApi* | [**create_users_logout**](docs/UsersApi.md#create_users_logout) | **POST** /companies/{company_id}/users/logout | Logout current user by revoking their sessions
-*SparteraApiSdk::UsersApi* | [**delete_users**](docs/UsersApi.md#delete_users) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID
-*SparteraApiSdk::UsersApi* | [**get_users_by_id**](docs/UsersApi.md#get_users_by_id) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID
-*SparteraApiSdk::UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /companies/{company_id}/users | Get a list of all users in a company
-*SparteraApiSdk::UsersApi* | [**list_users_me**](docs/UsersApi.md#list_users_me) | **GET** /me | Get current authenticated user's profile.
-*SparteraApiSdk::UsersApi* | [**update_users**](docs/UsersApi.md#update_users) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID
-
-
-## Documentation for Models
-
- - [SparteraApiSdk::Alerts](docs/Alerts.md)
- - [SparteraApiSdk::AlertsInput](docs/AlertsInput.md)
- - [SparteraApiSdk::AlertsUpdate](docs/AlertsUpdate.md)
- - [SparteraApiSdk::ApiKeys](docs/ApiKeys.md)
- - [SparteraApiSdk::ApiKeysInput](docs/ApiKeysInput.md)
- - [SparteraApiSdk::ApiKeysUpdate](docs/ApiKeysUpdate.md)
- - [SparteraApiSdk::AssetPriceHistory](docs/AssetPriceHistory.md)
- - [SparteraApiSdk::AssetPriceHistoryInput](docs/AssetPriceHistoryInput.md)
- - [SparteraApiSdk::AssetPriceHistoryUpdate](docs/AssetPriceHistoryUpdate.md)
- - [SparteraApiSdk::AssetUsecases](docs/AssetUsecases.md)
- - [SparteraApiSdk::Assets](docs/Assets.md)
- - [SparteraApiSdk::AssetsInput](docs/AssetsInput.md)
- - [SparteraApiSdk::AssetsUpdate](docs/AssetsUpdate.md)
- - [SparteraApiSdk::CloudProviders](docs/CloudProviders.md)
- - [SparteraApiSdk::CloudProvidersInput](docs/CloudProvidersInput.md)
- - [SparteraApiSdk::CloudProvidersUpdate](docs/CloudProvidersUpdate.md)
- - [SparteraApiSdk::Companies](docs/Companies.md)
- - [SparteraApiSdk::CompaniesInput](docs/CompaniesInput.md)
- - [SparteraApiSdk::CompaniesUpdate](docs/CompaniesUpdate.md)
- - [SparteraApiSdk::Connections](docs/Connections.md)
- - [SparteraApiSdk::ConnectionsInput](docs/ConnectionsInput.md)
- - [SparteraApiSdk::ConnectionsUpdate](docs/ConnectionsUpdate.md)
- - [SparteraApiSdk::CreateAlerts200Response](docs/CreateAlerts200Response.md)
- - [SparteraApiSdk::CreateAlerts200ResponseData](docs/CreateAlerts200ResponseData.md)
- - [SparteraApiSdk::CreateApiKeys200Response](docs/CreateApiKeys200Response.md)
- - [SparteraApiSdk::CreateApiKeys200ResponseData](docs/CreateApiKeys200ResponseData.md)
- - [SparteraApiSdk::CreateAssetPriceHistory200Response](docs/CreateAssetPriceHistory200Response.md)
- - [SparteraApiSdk::CreateAssetPriceHistory200ResponseData](docs/CreateAssetPriceHistory200ResponseData.md)
- - [SparteraApiSdk::CreateAssetsAnalyze200Response](docs/CreateAssetsAnalyze200Response.md)
- - [SparteraApiSdk::CreateAssetsAnalyze200ResponseData](docs/CreateAssetsAnalyze200ResponseData.md)
- - [SparteraApiSdk::CreateConnections200Response](docs/CreateConnections200Response.md)
- - [SparteraApiSdk::CreateConnections200ResponseData](docs/CreateConnections200ResponseData.md)
- - [SparteraApiSdk::CreateEndpoints200Response](docs/CreateEndpoints200Response.md)
- - [SparteraApiSdk::CreateEndpoints200ResponseData](docs/CreateEndpoints200ResponseData.md)
- - [SparteraApiSdk::CreateFavorites200Response](docs/CreateFavorites200Response.md)
- - [SparteraApiSdk::CreateFavorites200ResponseData](docs/CreateFavorites200ResponseData.md)
- - [SparteraApiSdk::CreatePostgenIntegrations200Response](docs/CreatePostgenIntegrations200Response.md)
- - [SparteraApiSdk::CreatePostgenIntegrations200ResponseData](docs/CreatePostgenIntegrations200ResponseData.md)
- - [SparteraApiSdk::CreatePosts200Response](docs/CreatePosts200Response.md)
- - [SparteraApiSdk::CreatePosts200ResponseData](docs/CreatePosts200ResponseData.md)
- - [SparteraApiSdk::CreateUsers200Response](docs/CreateUsers200Response.md)
- - [SparteraApiSdk::CreateUsers200ResponseData](docs/CreateUsers200ResponseData.md)
- - [SparteraApiSdk::DeleteAlerts200Response](docs/DeleteAlerts200Response.md)
- - [SparteraApiSdk::DeleteAlerts200ResponseData](docs/DeleteAlerts200ResponseData.md)
- - [SparteraApiSdk::DeleteApiKeys200Response](docs/DeleteApiKeys200Response.md)
- - [SparteraApiSdk::DeleteApiKeys200ResponseData](docs/DeleteApiKeys200ResponseData.md)
- - [SparteraApiSdk::DeleteAssetPriceHistory200Response](docs/DeleteAssetPriceHistory200Response.md)
- - [SparteraApiSdk::DeleteAssetPriceHistory200ResponseData](docs/DeleteAssetPriceHistory200ResponseData.md)
- - [SparteraApiSdk::DeleteAssets200Response](docs/DeleteAssets200Response.md)
- - [SparteraApiSdk::DeleteAssets200ResponseData](docs/DeleteAssets200ResponseData.md)
- - [SparteraApiSdk::DeleteConnections200Response](docs/DeleteConnections200Response.md)
- - [SparteraApiSdk::DeleteConnections200ResponseData](docs/DeleteConnections200ResponseData.md)
- - [SparteraApiSdk::DeleteEndpoints200Response](docs/DeleteEndpoints200Response.md)
- - [SparteraApiSdk::DeleteEndpoints200ResponseData](docs/DeleteEndpoints200ResponseData.md)
- - [SparteraApiSdk::DeleteFavorites200Response](docs/DeleteFavorites200Response.md)
- - [SparteraApiSdk::DeleteFavorites200ResponseData](docs/DeleteFavorites200ResponseData.md)
- - [SparteraApiSdk::DeletePostgenIntegrations200Response](docs/DeletePostgenIntegrations200Response.md)
- - [SparteraApiSdk::DeletePostgenIntegrations200ResponseData](docs/DeletePostgenIntegrations200ResponseData.md)
- - [SparteraApiSdk::DeletePosts200Response](docs/DeletePosts200Response.md)
- - [SparteraApiSdk::DeletePosts200ResponseData](docs/DeletePosts200ResponseData.md)
- - [SparteraApiSdk::DeleteUsers200Response](docs/DeleteUsers200Response.md)
- - [SparteraApiSdk::DeleteUsers200ResponseData](docs/DeleteUsers200ResponseData.md)
- - [SparteraApiSdk::Endpoints](docs/Endpoints.md)
- - [SparteraApiSdk::EndpointsInput](docs/EndpointsInput.md)
- - [SparteraApiSdk::EndpointsUpdate](docs/EndpointsUpdate.md)
- - [SparteraApiSdk::Error](docs/Error.md)
- - [SparteraApiSdk::Favorites](docs/Favorites.md)
- - [SparteraApiSdk::FavoritesInput](docs/FavoritesInput.md)
- - [SparteraApiSdk::FavoritesUpdate](docs/FavoritesUpdate.md)
- - [SparteraApiSdk::GetAlertsById200Response](docs/GetAlertsById200Response.md)
- - [SparteraApiSdk::GetApiKeysById200Response](docs/GetApiKeysById200Response.md)
- - [SparteraApiSdk::GetAssetPriceHistoryById200Response](docs/GetAssetPriceHistoryById200Response.md)
- - [SparteraApiSdk::GetAssetUsecasesById200Response](docs/GetAssetUsecasesById200Response.md)
- - [SparteraApiSdk::GetAssetsByIdAnalyze200Response](docs/GetAssetsByIdAnalyze200Response.md)
- - [SparteraApiSdk::GetCloudProvidersById200Response](docs/GetCloudProvidersById200Response.md)
- - [SparteraApiSdk::GetCompaniesById200Response](docs/GetCompaniesById200Response.md)
- - [SparteraApiSdk::GetConnectionsById200Response](docs/GetConnectionsById200Response.md)
- - [SparteraApiSdk::GetEndpointsByIdConnectionsDescribe200Response](docs/GetEndpointsByIdConnectionsDescribe200Response.md)
- - [SparteraApiSdk::GetFavoritesById200Response](docs/GetFavoritesById200Response.md)
- - [SparteraApiSdk::GetIndustriesById200Response](docs/GetIndustriesById200Response.md)
- - [SparteraApiSdk::GetJobFunctionsById200Response](docs/GetJobFunctionsById200Response.md)
- - [SparteraApiSdk::GetPostgenIntegrationsById200Response](docs/GetPostgenIntegrationsById200Response.md)
- - [SparteraApiSdk::GetPostsById200Response](docs/GetPostsById200Response.md)
- - [SparteraApiSdk::GetStorageEnginesById200Response](docs/GetStorageEnginesById200Response.md)
- - [SparteraApiSdk::GetUsersById200Response](docs/GetUsersById200Response.md)
- - [SparteraApiSdk::Industries](docs/Industries.md)
- - [SparteraApiSdk::InlineObject](docs/InlineObject.md)
- - [SparteraApiSdk::InlineObject1](docs/InlineObject1.md)
- - [SparteraApiSdk::InlineObject2](docs/InlineObject2.md)
- - [SparteraApiSdk::InlineObject3](docs/InlineObject3.md)
- - [SparteraApiSdk::InlineObject4](docs/InlineObject4.md)
- - [SparteraApiSdk::InlineObject5](docs/InlineObject5.md)
- - [SparteraApiSdk::InlineObject6](docs/InlineObject6.md)
- - [SparteraApiSdk::InlineObject7](docs/InlineObject7.md)
- - [SparteraApiSdk::JobFunctions](docs/JobFunctions.md)
- - [SparteraApiSdk::JobFunctionsInput](docs/JobFunctionsInput.md)
- - [SparteraApiSdk::JobFunctionsUpdate](docs/JobFunctionsUpdate.md)
- - [SparteraApiSdk::ListApiKeys200Response](docs/ListApiKeys200Response.md)
- - [SparteraApiSdk::ListAssetUsecases200Response](docs/ListAssetUsecases200Response.md)
- - [SparteraApiSdk::ListAssets200Response](docs/ListAssets200Response.md)
- - [SparteraApiSdk::ListCloudProviders200Response](docs/ListCloudProviders200Response.md)
- - [SparteraApiSdk::ListCompaniesAnalyticsAssets200Response](docs/ListCompaniesAnalyticsAssets200Response.md)
- - [SparteraApiSdk::ListConnections200Response](docs/ListConnections200Response.md)
- - [SparteraApiSdk::ListEndpoints200Response](docs/ListEndpoints200Response.md)
- - [SparteraApiSdk::ListIndustries200Response](docs/ListIndustries200Response.md)
- - [SparteraApiSdk::ListJobFunctions200Response](docs/ListJobFunctions200Response.md)
- - [SparteraApiSdk::ListPostgenIntegrations200Response](docs/ListPostgenIntegrations200Response.md)
- - [SparteraApiSdk::ListPosts200Response](docs/ListPosts200Response.md)
- - [SparteraApiSdk::ListStorageEngines200Response](docs/ListStorageEngines200Response.md)
- - [SparteraApiSdk::ListUsers200Response](docs/ListUsers200Response.md)
- - [SparteraApiSdk::PostPublications](docs/PostPublications.md)
- - [SparteraApiSdk::PostPublicationsInput](docs/PostPublicationsInput.md)
- - [SparteraApiSdk::PostPublicationsUpdate](docs/PostPublicationsUpdate.md)
- - [SparteraApiSdk::PostgenIntegrations](docs/PostgenIntegrations.md)
- - [SparteraApiSdk::PostgenIntegrationsInput](docs/PostgenIntegrationsInput.md)
- - [SparteraApiSdk::PostgenIntegrationsUpdate](docs/PostgenIntegrationsUpdate.md)
- - [SparteraApiSdk::Posts](docs/Posts.md)
- - [SparteraApiSdk::PostsInput](docs/PostsInput.md)
- - [SparteraApiSdk::PostsUpdate](docs/PostsUpdate.md)
- - [SparteraApiSdk::StorageEngines](docs/StorageEngines.md)
- - [SparteraApiSdk::UpdateAlerts200Response](docs/UpdateAlerts200Response.md)
- - [SparteraApiSdk::UpdateAlerts200ResponseData](docs/UpdateAlerts200ResponseData.md)
- - [SparteraApiSdk::UpdateApiKeys200Response](docs/UpdateApiKeys200Response.md)
- - [SparteraApiSdk::UpdateApiKeys200ResponseData](docs/UpdateApiKeys200ResponseData.md)
- - [SparteraApiSdk::UpdateAssetPriceHistory200Response](docs/UpdateAssetPriceHistory200Response.md)
- - [SparteraApiSdk::UpdateAssetPriceHistory200ResponseData](docs/UpdateAssetPriceHistory200ResponseData.md)
- - [SparteraApiSdk::UpdateAssets200Response](docs/UpdateAssets200Response.md)
- - [SparteraApiSdk::UpdateAssets200ResponseData](docs/UpdateAssets200ResponseData.md)
- - [SparteraApiSdk::UpdateCompanies200Response](docs/UpdateCompanies200Response.md)
- - [SparteraApiSdk::UpdateCompanies200ResponseData](docs/UpdateCompanies200ResponseData.md)
- - [SparteraApiSdk::UpdateConnections200Response](docs/UpdateConnections200Response.md)
- - [SparteraApiSdk::UpdateConnections200ResponseData](docs/UpdateConnections200ResponseData.md)
- - [SparteraApiSdk::UpdateEndpoints200Response](docs/UpdateEndpoints200Response.md)
- - [SparteraApiSdk::UpdateEndpoints200ResponseData](docs/UpdateEndpoints200ResponseData.md)
- - [SparteraApiSdk::UpdateFavorites200Response](docs/UpdateFavorites200Response.md)
- - [SparteraApiSdk::UpdateFavorites200ResponseData](docs/UpdateFavorites200ResponseData.md)
- - [SparteraApiSdk::UpdatePostgenIntegrations200Response](docs/UpdatePostgenIntegrations200Response.md)
- - [SparteraApiSdk::UpdatePostgenIntegrations200ResponseData](docs/UpdatePostgenIntegrations200ResponseData.md)
- - [SparteraApiSdk::UpdatePosts200Response](docs/UpdatePosts200Response.md)
- - [SparteraApiSdk::UpdatePosts200ResponseData](docs/UpdatePosts200ResponseData.md)
- - [SparteraApiSdk::UpdateUsers200Response](docs/UpdateUsers200Response.md)
- - [SparteraApiSdk::UpdateUsers200ResponseData](docs/UpdateUsers200ResponseData.md)
- - [SparteraApiSdk::Users](docs/Users.md)
- - [SparteraApiSdk::UsersInput](docs/UsersInput.md)
- - [SparteraApiSdk::UsersUpdate](docs/UsersUpdate.md)
-
-
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-### ApiKeyAuth
-
-
-- **Type**: API key
-- **API key parameter name**: x-api-key
-- **Location**: HTTP header
+## Package Manager
+- **Platform**: RubyGems
+- **Install**: `gem install spartera_api_sdk`
+- **Import**: `require 'spartera_api_sdk'`
 
+## Publishing
+1. Build: `gem build *.gemspec`
+2. Push: `gem push *.gem`
+3. Install: `gem install spartera_api_sdk`