spartera_api_sdk 1.0.77 → 1.0.78

data/docs/FavoritesInput.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **asset_id** | **String** |  |  |
-| **user_id** | **String** |  | [optional] |
-| **company_id** | **String** |  |  |
+| **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. |  |
+| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
+| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. |  |
 | **notes** | **String** | Optional user notes about this favorite | [optional] |
 | **category** | **String** | Optional category for organizing favorites (e.g., 'Work', 'Research') | [optional] |
 | **priority** | **Integer** | User-defined priority for sorting (higher = more important) | [optional] |
@@ -17,12 +17,12 @@
 require 'spartera_api_sdk'
 
 instance = SparteraApiSdk::FavoritesInput.new(
-  asset_id: null,
-  user_id: null,
-  company_id: null,
-  notes: null,
-  category: null,
-  priority: null
+  asset_id: asset_id_abc123,
+  user_id: user_id_abc123,
+  company_id: company_id_abc123,
+  notes: example_value,
+  category: example_value,
+  priority: 1
 )
 ```
 

data/docs/FavoritesUpdate.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **asset_id** | **String** |  | [optional] |
-| **user_id** | **String** |  | [optional] |
-| **company_id** | **String** |  | [optional] |
+| **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. | [optional] |
+| **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
+| **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | [optional] |
 | **notes** | **String** | Optional user notes about this favorite | [optional] |
 | **category** | **String** | Optional category for organizing favorites (e.g., 'Work', 'Research') | [optional] |
 | **priority** | **Integer** | User-defined priority for sorting (higher = more important) | [optional] |
@@ -17,12 +17,12 @@
 require 'spartera_api_sdk'
 
 instance = SparteraApiSdk::FavoritesUpdate.new(
-  asset_id: null,
-  user_id: null,
-  company_id: null,
-  notes: null,
-  category: null,
-  priority: null
+  asset_id: asset_id_abc123,
+  user_id: user_id_abc123,
+  company_id: company_id_abc123,
+  notes: example_value,
+  category: example_value,
+  priority: 1
 )
 ```
 

data/docs/{CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response.md → GetAlertsById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response
+# SparteraApiSdk::GetAlertsById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response.new(
+instance = SparteraApiSdk::GetAlertsById200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdApiKeysApiKeyIdGet200Response.md → GetApiKeysById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdApiKeysApiKeyIdGet200Response
+# SparteraApiSdk::GetApiKeysById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdApiKeysApiKeyIdGet200Response.new(
+instance = SparteraApiSdk::GetApiKeysById200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response.md → GetAssetPriceHistoryById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response
+# SparteraApiSdk::GetAssetPriceHistoryById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response.new(
+instance = SparteraApiSdk::GetAssetPriceHistoryById200Response.new(
   message: success,
   data: null
 )

data/docs/GetAssetUsecasesById200Response.md

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

data/docs/{AnalyzeCompanyHandleAssetsAssetSlugGet200Response.md → GetAssetsByIdAnalyze200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::AnalyzeCompanyHandleAssetsAssetSlugGet200Response
+# SparteraApiSdk::GetAssetsByIdAnalyze200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::AnalyzeCompanyHandleAssetsAssetSlugGet200Response.new(
+instance = SparteraApiSdk::GetAssetsByIdAnalyze200Response.new(
   message: success,
   data: null
 )

data/docs/{CloudProvidersProviderIdGet200Response.md → GetCloudProvidersById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CloudProvidersProviderIdGet200Response
+# SparteraApiSdk::GetCloudProvidersById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CloudProvidersProviderIdGet200Response.new(
+instance = SparteraApiSdk::GetCloudProvidersById200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdGet200Response.md → GetCompaniesById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdGet200Response
+# SparteraApiSdk::GetCompaniesById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdGet200Response.new(
+instance = SparteraApiSdk::GetCompaniesById200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdConnectionsConnectionIdGet200Response.md → GetConnectionsById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdGet200Response
+# SparteraApiSdk::GetConnectionsById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdGet200Response.new(
+instance = SparteraApiSdk::GetConnectionsById200Response.new(
   message: success,
   data: null
 )

data/docs/GetEndpointsByIdConnectionsDescribe200Response.md

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

data/docs/{CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response.md → GetFavoritesById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response
+# SparteraApiSdk::GetFavoritesById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response.new(
+instance = SparteraApiSdk::GetFavoritesById200Response.new(
   message: success,
   data: null
 )

data/docs/GetIndustriesById200Response.md

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

data/docs/{JobFunctionsFunctionIdGet200Response.md → GetJobFunctionsById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::JobFunctionsFunctionIdGet200Response
+# SparteraApiSdk::GetJobFunctionsById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::JobFunctionsFunctionIdGet200Response.new(
+instance = SparteraApiSdk::GetJobFunctionsById200Response.new(
   message: success,
   data: null
 )

data/docs/GetPostgenIntegrationsById200Response.md

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

data/docs/GetPostsById200Response.md

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

data/docs/GetStorageEnginesById200Response.md

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

data/docs/{CompaniesCompanyIdUsersUserIdGet200Response.md → GetUsersById200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdUsersUserIdGet200Response
+# SparteraApiSdk::GetUsersById200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdUsersUserIdGet200Response.new(
+instance = SparteraApiSdk::GetUsersById200Response.new(
   message: success,
   data: null
 )

data/docs/Industries.md

@@ -0,0 +1,32 @@
+# SparteraApiSdk::Industries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | Optional. | [optional] |
+| **last_updated** | **Time** | Optional. | [optional] |
+| **industry_id** | **Integer** | Auto-generated unique identifier. | [optional] |
+| **industry_name** | **String** | Required. Must be unique. |  |
+| **short_name** | **String** | Required. |  |
+| **slug** | **String** | Optional. | [optional] |
+| **naisc_code** | **Integer** | Optional. | [optional] |
+| **description** | **String** | Optional. | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Industries.new(
+  date_created: 2025-04-01T00:00:00Z,
+  last_updated: 2025-04-01T00:00:00Z,
+  industry_id: 1,
+  industry_name: Example Name,
+  short_name: Example Name,
+  slug: example-slug,
+  naisc_code: ABC123,
+  description: Example description.
+)
+```
+

data/docs/IndustriesApi.md

@@ -0,0 +1,237 @@
+# SparteraApiSdk::IndustriesApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_industries_by_id**](IndustriesApi.md#get_industries_by_id) | **GET** /industries/{industry_id} | Get single industry by ID |
+| [**list_industries**](IndustriesApi.md#list_industries) | **GET** /industries | Get a list of all industries |
+| [**list_industries_active**](IndustriesApi.md#list_industries_active) | **GET** /industries/active | Get a list of industries that have active marketplace products |
+
+
+## get_industries_by_id
+
+> <GetIndustriesById200Response> get_industries_by_id(industry_id)
+
+Get single industry 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::IndustriesApi.new
+industry_id = 'industry_id_example' # String | Unique identifier for the Industry
+
+begin
+  # Get single industry by ID
+  result = api_instance.get_industries_by_id(industry_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->get_industries_by_id: #{e}"
+end
+```
+
+#### Using the get_industries_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetIndustriesById200Response>, Integer, Hash)> get_industries_by_id_with_http_info(industry_id)
+
+```ruby
+begin
+  # Get single industry by ID
+  data, status_code, headers = api_instance.get_industries_by_id_with_http_info(industry_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetIndustriesById200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->get_industries_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **industry_id** | **String** | Unique identifier for the Industry |  |
+
+### Return type
+
+[**GetIndustriesById200Response**](GetIndustriesById200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_industries
+
+> <ListIndustries200Response> list_industries(opts)
+
+Get a list of all industries
+
+### 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::IndustriesApi.new
+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 industries
+  result = api_instance.list_industries(opts)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->list_industries: #{e}"
+end
+```
+
+#### Using the list_industries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListIndustries200Response>, Integer, Hash)> list_industries_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of all industries
+  data, status_code, headers = api_instance.list_industries_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListIndustries200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->list_industries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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
+
+[**ListIndustries200Response**](ListIndustries200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_industries_active
+
+> <ListIndustries200Response> list_industries_active(opts)
+
+Get a list of industries that have active marketplace products
+
+### 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::IndustriesApi.new
+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 industries that have active marketplace products
+  result = api_instance.list_industries_active(opts)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->list_industries_active: #{e}"
+end
+```
+
+#### Using the list_industries_active_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListIndustries200Response>, Integer, Hash)> list_industries_active_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of industries that have active marketplace products
+  data, status_code, headers = api_instance.list_industries_active_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListIndustries200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling IndustriesApi->list_industries_active_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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
+
+[**ListIndustries200Response**](ListIndustries200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/InlineObject4.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::InlineObject4
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::InlineObject4.new(
+  code: 409,
+  message: Resource already exists
+)
+```
+

data/docs/InlineObject5.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::InlineObject5
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::InlineObject5.new(
+  code: 422,
+  message: Cannot process request
+)
+```
+

data/docs/InlineObject6.md

@@ -0,0 +1,22 @@
+# SparteraApiSdk::InlineObject6
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **retry_after** | **Integer** | Seconds to wait before retrying | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::InlineObject6.new(
+  code: 429,
+  message: Rate limit exceeded,
+  retry_after: 60
+)
+```
+