spartera_api_sdk 1.0.58

data/docs/AlertsApi.md

@@ -0,0 +1,511 @@
+# SparteraApiSdk::AlertsApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_company_id_users_user_id_alerts_alert_id_delete**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID |
+| [**companies_company_id_users_user_id_alerts_alert_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Get single alert by ID |
+| [**companies_company_id_users_user_id_alerts_alert_id_patch**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID |
+| [**companies_company_id_users_user_id_alerts_asset_asset_id_all_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_all_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins |
+| [**companies_company_id_users_user_id_alerts_asset_asset_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset |
+| [**companies_company_id_users_user_id_alerts_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_get) | **GET** /companies/{company_id}/users/{user_id}/alerts | Get a list of all alerts for a specific user |
+| [**companies_company_id_users_user_id_alerts_post**](AlertsApi.md#companies_company_id_users_user_id_alerts_post) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts |
+
+
+## companies_company_id_users_user_id_alerts_alert_id_delete
+
+> Object companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
+
+Delete single alert by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+alert_id = 'alert_id_example' # String | 
+
+begin
+  # Delete single alert by ID
+  result = api_instance.companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_delete: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
+
+```ruby
+begin
+  # Delete single alert by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **alert_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_alert_id_get
+
+> Object companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
+
+Get single alert by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+alert_id = 'alert_id_example' # String | 
+
+begin
+  # Get single alert by ID
+  result = api_instance.companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_alert_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
+
+```ruby
+begin
+  # Get single alert by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **alert_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_alert_id_patch
+
+> Object companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
+
+Update an existing alert by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+alert_id = 'alert_id_example' # String | 
+alert = SparteraApiSdk::Alert.new({asset_id: 'asset_id_example', company_id: 'company_id_example', alert_type: 'alert_type_example'}) # Alert | 
+
+begin
+  # Update an existing alert by ID
+  result = api_instance.companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_patch: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
+
+```ruby
+begin
+  # Update an existing alert by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **alert_id** | **String** |  |  |
+| **alert** | [**Alert**](Alert.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_asset_asset_id_all_get
+
+> Object companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
+
+Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+  result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_all_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
+
+```ruby
+begin
+  # Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_asset_asset_id_get
+
+> Object companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
+
+Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+  result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
+
+```ruby
+begin
+  # Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_get
+
+> Object companies_company_id_users_user_id_alerts_get(company_id, user_id)
+
+Get a list of all alerts for a specific user
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+
+begin
+  # Get a list of all alerts for a specific user
+  result = api_instance.companies_company_id_users_user_id_alerts_get(company_id, user_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
+
+```ruby
+begin
+  # Get a list of all alerts for a specific user
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_alerts_post
+
+> Object companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
+
+POST /companies/{company_id}/users/{user_id}/alerts
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AlertsApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+alert = SparteraApiSdk::Alert.new({asset_id: 'asset_id_example', company_id: 'company_id_example', alert_type: 'alert_type_example'}) # Alert | 
+
+begin
+  # POST /companies/{company_id}/users/{user_id}/alerts
+  result = api_instance.companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_post: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_alerts_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
+
+```ruby
+begin
+  # POST /companies/{company_id}/users/{user_id}/alerts
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **alert** | [**Alert**](Alert.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Apikey.md

@@ -0,0 +1,36 @@
+# SparteraApiSdk::Apikey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_id** | **String** |  | [readonly] |
+| **user_id** | **String** |  | [optional] |
+| **company_id** | **String** |  |  |
+| **role_id** | **String** |  |  |
+| **token** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **expiration_date_utc** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional] |
+| **last_updated** | **String** |  | [optional] |
+| **active** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Apikey.new(
+  api_key_id: null,
+  user_id: null,
+  company_id: null,
+  role_id: null,
+  token: null,
+  name: null,
+  expiration_date_utc: null,
+  date_created: null,
+  last_updated: null,
+  active: null
+)
+```
+

data/docs/Asset.md

@@ -0,0 +1,110 @@
+# SparteraApiSdk::Asset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asset_id** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **company_id** | **String** |  |  |
+| **connection_id** | **String** |  | [optional] |
+| **llm_connection_id** | **String** |  | [optional] |
+| **snippet_id** | **String** |  | [optional] |
+| **industry_id** | **String** |  | [optional] |
+| **ai_job_id** | **String** |  | [optional] |
+| **approval_status** | **String** |  | [optional] |
+| **approved_by_user_id** | **String** |  | [optional] |
+| **approved_at** | **String** |  | [optional] |
+| **name** | **String** |  |  |
+| **slug** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **source** | **String** |  |  |
+| **asset_type** | **String** |  | [optional] |
+| **asset_schema** | **String** |  | [optional] |
+| **visibility** | **String** |  | [optional] |
+| **tags** | **String** |  | [optional] |
+| **sql_logic** | **String** |  | [optional] |
+| **source_schema_name** | **String** |  | [optional] |
+| **source_table_name** | **String** |  | [optional] |
+| **sell_in_marketplace** | **String** |  | [optional] |
+| **viz_chart_library** | **String** |  | [optional] |
+| **viz_chart_type** | **String** |  | [optional] |
+| **viz_dep_var_col_name** | **String** |  | [optional] |
+| **viz_indep_var_col_name** | **String** |  | [optional] |
+| **viz_size_col_name** | **String** |  | [optional] |
+| **viz_color_col_name** | **String** |  | [optional] |
+| **viz_data_aggregation** | **String** |  | [optional] |
+| **viz_sort_direction** | **String** |  | [optional] |
+| **viz_data_limit** | **String** |  | [optional] |
+| **viz_color_scheme** | **String** |  | [optional] |
+| **allow_params** | **String** |  | [optional] |
+| **accept_terms** | **String** |  | [optional] |
+| **cached** | **String** |  | [optional] |
+| **schedule** | **String** |  | [optional] |
+| **next_run** | **String** |  | [optional] |
+| **data_time_period_start** | **String** |  | [optional] |
+| **data_time_period_end** | **String** |  | [optional] |
+| **geographic_coverage_type** | **String** |  | [optional] |
+| **geographic_coverage_details** | **String** |  | [optional] |
+| **data_source_refresh_frequency** | **String** |  | [optional] |
+| **data_source_last_refreshed** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional] |
+| **last_updated** | **String** |  | [optional] |
+| **active** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Asset.new(
+  asset_id: null,
+  user_id: null,
+  company_id: null,
+  connection_id: null,
+  llm_connection_id: null,
+  snippet_id: null,
+  industry_id: null,
+  ai_job_id: null,
+  approval_status: null,
+  approved_by_user_id: null,
+  approved_at: null,
+  name: null,
+  slug: null,
+  description: null,
+  source: null,
+  asset_type: null,
+  asset_schema: null,
+  visibility: null,
+  tags: null,
+  sql_logic: null,
+  source_schema_name: null,
+  source_table_name: null,
+  sell_in_marketplace: null,
+  viz_chart_library: null,
+  viz_chart_type: null,
+  viz_dep_var_col_name: null,
+  viz_indep_var_col_name: null,
+  viz_size_col_name: null,
+  viz_color_col_name: null,
+  viz_data_aggregation: null,
+  viz_sort_direction: null,
+  viz_data_limit: null,
+  viz_color_scheme: null,
+  allow_params: null,
+  accept_terms: null,
+  cached: null,
+  schedule: null,
+  next_run: null,
+  data_time_period_start: null,
+  data_time_period_end: null,
+  geographic_coverage_type: null,
+  geographic_coverage_details: null,
+  data_source_refresh_frequency: null,
+  data_source_last_refreshed: null,
+  date_created: null,
+  last_updated: null,
+  active: null
+)
+```
+