Metadata-Version: 2.4
Name: spartera_api_sdk
Version: 1.0.81
Summary: Spartera API Documentation
Home-page: https://github.com/spartera-com/spartera-python-sdk
Author: API Support
Author-email: API Support <support@spartera.com>
License: Apache 2.0
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Spartera API Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# spartera-api-sdk
Auto-generated API documentation for REST services of the Spartera platform

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.25.0
- Package version: 1.0.81
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import spartera_api_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import spartera_api_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import spartera_api_sdk
from spartera_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.spartera.com
# See configuration.py for a list of all supported configuration parameters.
configuration = spartera_api_sdk.Configuration(
    host = "https://api.spartera.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with spartera_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = spartera_api_sdk.APIKeysApi(api_client)
    company_id = 'company_id_example' # str | Unique identifier for the Company
    api_keys_input = spartera_api_sdk.ApiKeysInput() # ApiKeysInput | 
    page = 1 # int | Page number for pagination (optional) (default to 1)
    limit = 20 # int | Number of items per page (optional) (default to 20)
    sort_by = 'sort_by_example' # str | Field to sort by (optional)
    sort_order = desc # str | Sort order (ascending or descending) (optional) (default to desc)
    search = 'search_example' # str | Search term to filter results (optional)

    try:
        # Create single API key.     Returns the actual sk_ key (only time it's exposed) and api_key_id for future operations.
        api_response = api_instance.create_api_keys(company_id, api_keys_input, page=page, limit=limit, sort_by=sort_by, sort_order=sort_order, search=search)
        print("The response of APIKeysApi->create_api_keys:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->create_api_keys: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.spartera.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*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&#39;s exposed) and api_key_id for future operations.
*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.
*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.
*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).
*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.
*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).
*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).
*AlertsApi* | [**create_alerts**](docs/AlertsApi.md#create_alerts) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts
*AlertsApi* | [**delete_alerts**](docs/AlertsApi.md#delete_alerts) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID
*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
*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
*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
*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)
*AlertsApi* | [**update_alerts**](docs/AlertsApi.md#update_alerts) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID
*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
*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
*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
*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
*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
*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
*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
*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
*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
*AssetUsecasesApi* | [**list_asset_usecases**](docs/AssetUsecasesApi.md#list_asset_usecases) | **GET** /asset_usecases | Get a list of all asset use cases
*AssetsApi* | [**create_assets**](docs/AssetsApi.md#create_assets) | **POST** /companies/{company_id}/assets | Create a new asset
*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.
*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&#39;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
*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
*AssetsApi* | [**delete_assets**](docs/AssetsApi.md#delete_assets) | **DELETE** /companies/{company_id}/assets/{asset_id} | Delete single asset by ID
*AssetsApi* | [**get_assets_by_id**](docs/AssetsApi.md#get_assets_by_id) | **GET** /companies/{company_id}/assets/{asset_id} | Get single asset by ID
*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)
*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.
*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&#39;s table
*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&#39;s information schema
*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
*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
*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
*AssetsApi* | [**list_assets**](docs/AssetsApi.md#list_assets) | **GET** /companies/{company_id}/assets | Get all assets for a specific company
*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)
*AssetsApi* | [**update_assets**](docs/AssetsApi.md#update_assets) | **PATCH** /companies/{company_id}/assets/{asset_id} | Update an existing asset by ID
*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
*CloudProvidersApi* | [**list_cloud_providers**](docs/CloudProvidersApi.md#list_cloud_providers) | **GET** /cloud-providers | Get a list of all cloud providers
*CompaniesApi* | [**get_companies_by_id**](docs/CompaniesApi.md#get_companies_by_id) | **GET** /companies/{company_id} | Get details of the requestor&#39;s own company
*CompaniesApi* | [**list_companies**](docs/CompaniesApi.md#list_companies) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company&#39;s current subscription plan.
*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
*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
*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)
*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: &lt; 0.1s
*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
*CompaniesApi* | [**list_companies_objects**](docs/CompaniesApi.md#list_companies_objects) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company
*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.
*CompaniesApi* | [**update_companies**](docs/CompaniesApi.md#update_companies) | **PATCH** /companies/{company_id} | Update an existing company by ID
*ConnectionsApi* | [**create_connections**](docs/ConnectionsApi.md#create_connections) | **POST** /companies/{company_id}/connections | Create a new connection by ID
*ConnectionsApi* | [**delete_connections**](docs/ConnectionsApi.md#delete_connections) | **DELETE** /companies/{company_id}/connections/{connection_id} | Delete single connection by ID
*ConnectionsApi* | [**get_connections_by_id**](docs/ConnectionsApi.md#get_connections_by_id) | **GET** /companies/{company_id}/connections/{connection_id} | Get single connection by ID
*ConnectionsApi* | [**get_connections_by_id2**](docs/ConnectionsApi.md#get_connections_by_id2) | **GET** /companies/{company_id}/connections/{connection_id}/test | Test the specified connection
*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
*ConnectionsApi* | [**list_connections**](docs/ConnectionsApi.md#list_connections) | **GET** /companies/{company_id}/connections | Get all connections for a specific company
*ConnectionsApi* | [**update_connections**](docs/ConnectionsApi.md#update_connections) | **PATCH** /companies/{company_id}/connections/{connection_id} | Update an existing connection by ID
*EndpointsApi* | [**create_endpoints**](docs/EndpointsApi.md#create_endpoints) | **POST** /companies/{company_id}/endpoints | Create a new endpoint
*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
*EndpointsApi* | [**delete_endpoints**](docs/EndpointsApi.md#delete_endpoints) | **DELETE** /companies/{company_id}/endpoints/{endpoint_id} | Delete single endpoint by ID
*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}
*EndpointsApi* | [**get_endpoints_by_id**](docs/EndpointsApi.md#get_endpoints_by_id) | **GET** /companies/{company_id}/endpoints/{endpoint_id} | Get single endpoint by ID
*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
*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
*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&#x3D;0&amp;limit&#x3D;100
*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
*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)
*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)
*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
*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
*EndpointsApi* | [**update_endpoints**](docs/EndpointsApi.md#update_endpoints) | **PATCH** /companies/{company_id}/endpoints/{endpoint_id} | Update an existing endpoint by ID
*FavoritesApi* | [**create_favorites**](docs/FavoritesApi.md#create_favorites) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites
*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)
*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
*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
*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
*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
*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&#39;t have a category
*FavoritesApi* | [**update_favorites**](docs/FavoritesApi.md#update_favorites) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID
*IndustriesApi* | [**get_industries_by_id**](docs/IndustriesApi.md#get_industries_by_id) | **GET** /industries/{industry_id} | Get single industry by ID
*IndustriesApi* | [**list_industries**](docs/IndustriesApi.md#list_industries) | **GET** /industries | Get a list of all industries
*IndustriesApi* | [**list_industries_active**](docs/IndustriesApi.md#list_industries_active) | **GET** /industries/active | Get a list of industries that have active marketplace products
*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
*JobFunctionsApi* | [**list_job_functions**](docs/JobFunctionsApi.md#list_job_functions) | **GET** /job-functions | Get a list of all job functions
*PostgenIntegrationsApi* | [**create_postgen_integrations**](docs/PostgenIntegrationsApi.md#create_postgen_integrations) | **POST** /companies/{company_id}/postgen_integrations | POST /companies/{company_id}/postgen_integrations
*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
*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.
*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.
*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.
*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.
*PostsApi* | [**create_posts**](docs/PostsApi.md#create_posts) | **POST** /companies/{company_id}/posts | POST /companies/{company_id}/posts
*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
*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).
*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).
*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).
*PostsApi* | [**delete_posts**](docs/PostsApi.md#delete_posts) | **DELETE** /companies/{company_id}/posts/{post_id} | Delete single post by ID.
*PostsApi* | [**get_posts_by_id**](docs/PostsApi.md#get_posts_by_id) | **GET** /companies/{company_id}/posts/{post_id} | Get single post by ID.
*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
*PostsApi* | [**list_posts**](docs/PostsApi.md#list_posts) | **GET** /companies/{company_id}/posts | Get a list of all posts for the user&#39;s company.     Supports filtering, sorting, pagination.
*PostsApi* | [**list_posts_summary**](docs/PostsApi.md#list_posts_summary) | **GET** /companies/{company_id}/posts/summary | GET /companies/{company_id}/posts/summary
*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.
*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
*StorageEnginesApi* | [**list_storage_engines**](docs/StorageEnginesApi.md#list_storage_engines) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines
*UsersApi* | [**create_users**](docs/UsersApi.md#create_users) | **POST** /companies/{company_id}/users | Create a new user
*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
*UsersApi* | [**create_users_logout**](docs/UsersApi.md#create_users_logout) | **POST** /companies/{company_id}/users/logout | Logout current user by revoking their sessions
*UsersApi* | [**delete_users**](docs/UsersApi.md#delete_users) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID
*UsersApi* | [**get_users_by_id**](docs/UsersApi.md#get_users_by_id) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID
*UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /companies/{company_id}/users | Get a list of all users in a company
*UsersApi* | [**list_users_me**](docs/UsersApi.md#list_users_me) | **GET** /me | Get current authenticated user&#39;s profile.
*UsersApi* | [**update_users**](docs/UsersApi.md#update_users) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID


## Documentation For Models

 - [Alerts](docs/Alerts.md)
 - [AlertsInput](docs/AlertsInput.md)
 - [AlertsUpdate](docs/AlertsUpdate.md)
 - [ApiKeys](docs/ApiKeys.md)
 - [ApiKeysInput](docs/ApiKeysInput.md)
 - [ApiKeysUpdate](docs/ApiKeysUpdate.md)
 - [AssetPriceHistory](docs/AssetPriceHistory.md)
 - [AssetPriceHistoryInput](docs/AssetPriceHistoryInput.md)
 - [AssetPriceHistoryUpdate](docs/AssetPriceHistoryUpdate.md)
 - [AssetUsecases](docs/AssetUsecases.md)
 - [Assets](docs/Assets.md)
 - [AssetsInput](docs/AssetsInput.md)
 - [AssetsUpdate](docs/AssetsUpdate.md)
 - [CloudProviders](docs/CloudProviders.md)
 - [CloudProvidersInput](docs/CloudProvidersInput.md)
 - [CloudProvidersUpdate](docs/CloudProvidersUpdate.md)
 - [Companies](docs/Companies.md)
 - [CompaniesInput](docs/CompaniesInput.md)
 - [CompaniesUpdate](docs/CompaniesUpdate.md)
 - [Connections](docs/Connections.md)
 - [ConnectionsInput](docs/ConnectionsInput.md)
 - [ConnectionsUpdate](docs/ConnectionsUpdate.md)
 - [CreateAlerts200Response](docs/CreateAlerts200Response.md)
 - [CreateAlerts200ResponseData](docs/CreateAlerts200ResponseData.md)
 - [CreateApiKeys200Response](docs/CreateApiKeys200Response.md)
 - [CreateApiKeys200ResponseData](docs/CreateApiKeys200ResponseData.md)
 - [CreateAssetPriceHistory200Response](docs/CreateAssetPriceHistory200Response.md)
 - [CreateAssetPriceHistory200ResponseData](docs/CreateAssetPriceHistory200ResponseData.md)
 - [CreateAssetsAnalyze200Response](docs/CreateAssetsAnalyze200Response.md)
 - [CreateAssetsAnalyze200ResponseData](docs/CreateAssetsAnalyze200ResponseData.md)
 - [CreateConnections200Response](docs/CreateConnections200Response.md)
 - [CreateConnections200ResponseData](docs/CreateConnections200ResponseData.md)
 - [CreateEndpoints200Response](docs/CreateEndpoints200Response.md)
 - [CreateEndpoints200ResponseData](docs/CreateEndpoints200ResponseData.md)
 - [CreateFavorites200Response](docs/CreateFavorites200Response.md)
 - [CreateFavorites200ResponseData](docs/CreateFavorites200ResponseData.md)
 - [CreatePostgenIntegrations200Response](docs/CreatePostgenIntegrations200Response.md)
 - [CreatePostgenIntegrations200ResponseData](docs/CreatePostgenIntegrations200ResponseData.md)
 - [CreatePosts200Response](docs/CreatePosts200Response.md)
 - [CreatePosts200ResponseData](docs/CreatePosts200ResponseData.md)
 - [CreateUsers200Response](docs/CreateUsers200Response.md)
 - [CreateUsers200ResponseData](docs/CreateUsers200ResponseData.md)
 - [DeleteAlerts200Response](docs/DeleteAlerts200Response.md)
 - [DeleteAlerts200ResponseData](docs/DeleteAlerts200ResponseData.md)
 - [DeleteApiKeys200Response](docs/DeleteApiKeys200Response.md)
 - [DeleteApiKeys200ResponseData](docs/DeleteApiKeys200ResponseData.md)
 - [DeleteAssetPriceHistory200Response](docs/DeleteAssetPriceHistory200Response.md)
 - [DeleteAssetPriceHistory200ResponseData](docs/DeleteAssetPriceHistory200ResponseData.md)
 - [DeleteAssets200Response](docs/DeleteAssets200Response.md)
 - [DeleteAssets200ResponseData](docs/DeleteAssets200ResponseData.md)
 - [DeleteConnections200Response](docs/DeleteConnections200Response.md)
 - [DeleteConnections200ResponseData](docs/DeleteConnections200ResponseData.md)
 - [DeleteEndpoints200Response](docs/DeleteEndpoints200Response.md)
 - [DeleteEndpoints200ResponseData](docs/DeleteEndpoints200ResponseData.md)
 - [DeleteFavorites200Response](docs/DeleteFavorites200Response.md)
 - [DeleteFavorites200ResponseData](docs/DeleteFavorites200ResponseData.md)
 - [DeletePostgenIntegrations200Response](docs/DeletePostgenIntegrations200Response.md)
 - [DeletePostgenIntegrations200ResponseData](docs/DeletePostgenIntegrations200ResponseData.md)
 - [DeletePosts200Response](docs/DeletePosts200Response.md)
 - [DeletePosts200ResponseData](docs/DeletePosts200ResponseData.md)
 - [DeleteUsers200Response](docs/DeleteUsers200Response.md)
 - [DeleteUsers200ResponseData](docs/DeleteUsers200ResponseData.md)
 - [Endpoints](docs/Endpoints.md)
 - [EndpointsInput](docs/EndpointsInput.md)
 - [EndpointsUpdate](docs/EndpointsUpdate.md)
 - [Error](docs/Error.md)
 - [Favorites](docs/Favorites.md)
 - [FavoritesInput](docs/FavoritesInput.md)
 - [FavoritesUpdate](docs/FavoritesUpdate.md)
 - [GetAlertsById200Response](docs/GetAlertsById200Response.md)
 - [GetApiKeysById200Response](docs/GetApiKeysById200Response.md)
 - [GetAssetPriceHistoryById200Response](docs/GetAssetPriceHistoryById200Response.md)
 - [GetAssetUsecasesById200Response](docs/GetAssetUsecasesById200Response.md)
 - [GetAssetsByIdAnalyze200Response](docs/GetAssetsByIdAnalyze200Response.md)
 - [GetCloudProvidersById200Response](docs/GetCloudProvidersById200Response.md)
 - [GetCompaniesById200Response](docs/GetCompaniesById200Response.md)
 - [GetConnectionsById200Response](docs/GetConnectionsById200Response.md)
 - [GetEndpointsByIdConnectionsDescribe200Response](docs/GetEndpointsByIdConnectionsDescribe200Response.md)
 - [GetFavoritesById200Response](docs/GetFavoritesById200Response.md)
 - [GetIndustriesById200Response](docs/GetIndustriesById200Response.md)
 - [GetJobFunctionsById200Response](docs/GetJobFunctionsById200Response.md)
 - [GetPostgenIntegrationsById200Response](docs/GetPostgenIntegrationsById200Response.md)
 - [GetPostsById200Response](docs/GetPostsById200Response.md)
 - [GetStorageEnginesById200Response](docs/GetStorageEnginesById200Response.md)
 - [GetUsersById200Response](docs/GetUsersById200Response.md)
 - [Industries](docs/Industries.md)
 - [InlineObject](docs/InlineObject.md)
 - [InlineObject1](docs/InlineObject1.md)
 - [InlineObject2](docs/InlineObject2.md)
 - [InlineObject3](docs/InlineObject3.md)
 - [InlineObject4](docs/InlineObject4.md)
 - [InlineObject5](docs/InlineObject5.md)
 - [InlineObject6](docs/InlineObject6.md)
 - [InlineObject7](docs/InlineObject7.md)
 - [JobFunctions](docs/JobFunctions.md)
 - [JobFunctionsInput](docs/JobFunctionsInput.md)
 - [JobFunctionsUpdate](docs/JobFunctionsUpdate.md)
 - [ListApiKeys200Response](docs/ListApiKeys200Response.md)
 - [ListAssetUsecases200Response](docs/ListAssetUsecases200Response.md)
 - [ListAssets200Response](docs/ListAssets200Response.md)
 - [ListCloudProviders200Response](docs/ListCloudProviders200Response.md)
 - [ListCompaniesAnalyticsAssets200Response](docs/ListCompaniesAnalyticsAssets200Response.md)
 - [ListConnections200Response](docs/ListConnections200Response.md)
 - [ListEndpoints200Response](docs/ListEndpoints200Response.md)
 - [ListIndustries200Response](docs/ListIndustries200Response.md)
 - [ListJobFunctions200Response](docs/ListJobFunctions200Response.md)
 - [ListPostgenIntegrations200Response](docs/ListPostgenIntegrations200Response.md)
 - [ListPosts200Response](docs/ListPosts200Response.md)
 - [ListStorageEngines200Response](docs/ListStorageEngines200Response.md)
 - [ListUsers200Response](docs/ListUsers200Response.md)
 - [PostPublications](docs/PostPublications.md)
 - [PostPublicationsInput](docs/PostPublicationsInput.md)
 - [PostPublicationsUpdate](docs/PostPublicationsUpdate.md)
 - [PostgenIntegrations](docs/PostgenIntegrations.md)
 - [PostgenIntegrationsInput](docs/PostgenIntegrationsInput.md)
 - [PostgenIntegrationsUpdate](docs/PostgenIntegrationsUpdate.md)
 - [Posts](docs/Posts.md)
 - [PostsInput](docs/PostsInput.md)
 - [PostsUpdate](docs/PostsUpdate.md)
 - [StorageEngines](docs/StorageEngines.md)
 - [UpdateAlerts200Response](docs/UpdateAlerts200Response.md)
 - [UpdateAlerts200ResponseData](docs/UpdateAlerts200ResponseData.md)
 - [UpdateApiKeys200Response](docs/UpdateApiKeys200Response.md)
 - [UpdateApiKeys200ResponseData](docs/UpdateApiKeys200ResponseData.md)
 - [UpdateAssetPriceHistory200Response](docs/UpdateAssetPriceHistory200Response.md)
 - [UpdateAssetPriceHistory200ResponseData](docs/UpdateAssetPriceHistory200ResponseData.md)
 - [UpdateAssets200Response](docs/UpdateAssets200Response.md)
 - [UpdateAssets200ResponseData](docs/UpdateAssets200ResponseData.md)
 - [UpdateCompanies200Response](docs/UpdateCompanies200Response.md)
 - [UpdateCompanies200ResponseData](docs/UpdateCompanies200ResponseData.md)
 - [UpdateConnections200Response](docs/UpdateConnections200Response.md)
 - [UpdateConnections200ResponseData](docs/UpdateConnections200ResponseData.md)
 - [UpdateEndpoints200Response](docs/UpdateEndpoints200Response.md)
 - [UpdateEndpoints200ResponseData](docs/UpdateEndpoints200ResponseData.md)
 - [UpdateFavorites200Response](docs/UpdateFavorites200Response.md)
 - [UpdateFavorites200ResponseData](docs/UpdateFavorites200ResponseData.md)
 - [UpdatePostgenIntegrations200Response](docs/UpdatePostgenIntegrations200Response.md)
 - [UpdatePostgenIntegrations200ResponseData](docs/UpdatePostgenIntegrations200ResponseData.md)
 - [UpdatePosts200Response](docs/UpdatePosts200Response.md)
 - [UpdatePosts200ResponseData](docs/UpdatePosts200ResponseData.md)
 - [UpdateUsers200Response](docs/UpdateUsers200Response.md)
 - [UpdateUsers200ResponseData](docs/UpdateUsers200ResponseData.md)
 - [Users](docs/Users.md)
 - [UsersInput](docs/UsersInput.md)
 - [UsersUpdate](docs/UsersUpdate.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header


## Author

support@spartera.com


