neuland-hub-sdk 1.0.3

package/docs/System.md

@@ -0,0 +1,122 @@
+# System
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**systemReadSystemSettings**](#systemreadsystemsettings) | **GET** /system/settings | Read system settings|
+|[**systemUpdateSystemSettings**](#systemupdatesystemsettings) | **PATCH** /system/settings | Update system settings|
+
+# **systemReadSystemSettings**
+> SystemSettings systemReadSystemSettings()
+
+Return the current platform-wide system settings.
+
+### Example
+
+```typescript
+import {
+    System,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new System(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.systemReadSystemSettings(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SystemSettings**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Superadmin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **systemUpdateSystemSettings**
+> SystemSettings systemUpdateSystemSettings(systemSettingsUpdate)
+
+Apply the provided system settings changes and record an audit entry.
+
+### Example
+
+```typescript
+import {
+    System,
+    Configuration,
+    SystemSettingsUpdate
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new System(configuration);
+
+let systemSettingsUpdate: SystemSettingsUpdate; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.systemUpdateSystemSettings(
+    systemSettingsUpdate,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **systemSettingsUpdate** | **SystemSettingsUpdate**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SystemSettings**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | No changes were provided. |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Superadmin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/SystemSettings.md

@@ -0,0 +1,44 @@
+# SystemSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | UTC timestamp when the record was created. | [optional] [default to undefined]
+**updated_at** | **string** | UTC timestamp when the record was last updated. | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**maintenance_enabled** | **boolean** | Whether maintenance mode is currently enabled. | [optional] [default to false]
+**tracing_enabled** | **boolean** | Whether observability tracing is enabled system-wide. | [optional] [default to true]
+**inbound_guardrail_llm_settings_id** | **number** |  | [optional] [default to undefined]
+**outbound_guardrail_llm_settings_id** | **number** |  | [optional] [default to undefined]
+**title_llm_settings_id** | **number** |  | [optional] [default to undefined]
+**embedding_llm_settings_id** | **number** |  | [optional] [default to undefined]
+**transcription_llm_settings_id** | **number** |  | [optional] [default to undefined]
+**maintenance_start_at** | **string** |  | [optional] [default to undefined]
+**maintenance_end_at** | **string** |  | [optional] [default to undefined]
+**maintenance_message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SystemSettings } from 'neuland-hub-sdk';
+
+const instance: SystemSettings = {
+    created_at,
+    updated_at,
+    id,
+    maintenance_enabled,
+    tracing_enabled,
+    inbound_guardrail_llm_settings_id,
+    outbound_guardrail_llm_settings_id,
+    title_llm_settings_id,
+    embedding_llm_settings_id,
+    transcription_llm_settings_id,
+    maintenance_start_at,
+    maintenance_end_at,
+    maintenance_message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SystemSettingsUpdate.md

@@ -0,0 +1,41 @@
+# SystemSettingsUpdate
+
+Partial update of the platform-wide system settings. Only provided fields are changed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**maintenance_enabled** | **boolean** |  | [optional] [default to undefined]
+**tracing_enabled** | **boolean** |  | [optional] [default to undefined]
+**inbound_guardrail_llm_settings_id** | **string** |  | [optional] [default to undefined]
+**outbound_guardrail_llm_settings_id** | **string** |  | [optional] [default to undefined]
+**title_llm_settings_id** | **string** |  | [optional] [default to undefined]
+**embedding_llm_settings_id** | **string** |  | [optional] [default to undefined]
+**transcription_llm_settings_id** | **string** |  | [optional] [default to undefined]
+**maintenance_start_at** | **string** |  | [optional] [default to undefined]
+**maintenance_end_at** | **string** |  | [optional] [default to undefined]
+**maintenance_message** | **string** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SystemSettingsUpdate } from 'neuland-hub-sdk';
+
+const instance: SystemSettingsUpdate = {
+    maintenance_enabled,
+    tracing_enabled,
+    inbound_guardrail_llm_settings_id,
+    outbound_guardrail_llm_settings_id,
+    title_llm_settings_id,
+    embedding_llm_settings_id,
+    transcription_llm_settings_id,
+    maintenance_start_at,
+    maintenance_end_at,
+    maintenance_message,
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Tag.md

@@ -0,0 +1,187 @@
+# Tag
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**tagsDeleteTag**](#tagsdeletetag) | **DELETE** /tags/{tag_id} | Delete a tag|
+|[**tagsNewTag**](#tagsnewtag) | **POST** /tags/ | Create a tag|
+|[**tagsUpdateTag**](#tagsupdatetag) | **PATCH** /tags/{tag_id} | Rename a tag|
+
+# **tagsDeleteTag**
+> tagsDeleteTag()
+
+Delete a tag. CASCADE removes all taggings.
+
+### Example
+
+```typescript
+import {
+    Tag,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tag(configuration);
+
+let tagId: string; // (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tagsDeleteTag(
+    tagId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tagId** | [**string**] |  | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Tag belongs to another tenant. |  -  |
+|**404** | No tag exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **tagsNewTag**
+> Tag tagsNewTag(tagIn)
+
+Create a new tag in the caller\'s tenant.
+
+### Example
+
+```typescript
+import {
+    Tag,
+    Configuration,
+    TagIn
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tag(configuration);
+
+let tagIn: TagIn; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tagsNewTag(
+    tagIn,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tagIn** | **TagIn**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Tag**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **tagsUpdateTag**
+> Tag tagsUpdateTag(tagIn)
+
+Rename a tag in the caller\'s tenant.
+
+### Example
+
+```typescript
+import {
+    Tag,
+    Configuration,
+    TagIn
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tag(configuration);
+
+let tagId: string; // (default to undefined)
+let tagIn: TagIn; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tagsUpdateTag(
+    tagId,
+    tagIn,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tagIn** | **TagIn**|  | |
+| **tagId** | [**string**] |  | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Tag**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Tag belongs to another tenant. |  -  |
+|**404** | No tag exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/TagIn.md

@@ -0,0 +1,20 @@
+# TagIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Tag label, unique per tenant. Leading/trailing whitespace is stripped. | [default to undefined]
+
+## Example
+
+```typescript
+import { TagIn } from 'neuland-hub-sdk';
+
+const instance: TagIn = {
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaggableTypeEnum.md

@@ -0,0 +1,12 @@
+# TaggableTypeEnum
+
+
+## Enum
+
+* `ASSISTANT` (value: `'ASSISTANT'`)
+
+* `ASSISTANT_CATALOG` (value: `'ASSISTANT_CATALOG'`)
+
+* `APP_CATALOG` (value: `'APP_CATALOG'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Tagging.md

@@ -0,0 +1,32 @@
+# Tagging
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **string** | UTC timestamp when the record was created. | [optional] [default to undefined]
+**updated_at** | **string** | UTC timestamp when the record was last updated. | [optional] [default to undefined]
+**tag_id** | **number** | ID of the tag being applied. | [default to undefined]
+**taggable_type** | **string** | Resource type this tag is attached to. | [default to undefined]
+**taggable_id** | **number** | ID of the resource. | [default to undefined]
+**tenant_id** | **number** | ID of the tenant that owns the tagging. | [default to undefined]
+**creator_user_id** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Tagging } from 'neuland-hub-sdk';
+
+const instance: Tagging = {
+    created_at,
+    updated_at,
+    tag_id,
+    taggable_type,
+    taggable_id,
+    tenant_id,
+    creator_user_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Tarif.md

@@ -0,0 +1,189 @@
+# Tarif
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**tarifsCreateTarif**](#tarifscreatetarif) | **POST** /tarifs/ | Create a tarif plan|
+|[**tarifsDeleteTarif**](#tarifsdeletetarif) | **DELETE** /tarifs/{tarif_id} | Delete a tarif plan|
+|[**tarifsUpdateTarif**](#tarifsupdatetarif) | **PATCH** /tarifs/{tarif_id} | Update a tarif plan|
+
+# **tarifsCreateTarif**
+> Tarif tarifsCreateTarif(tarifIn)
+
+Create a new tarif plan.
+
+### Example
+
+```typescript
+import {
+    Tarif,
+    Configuration,
+    TarifIn
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tarif(configuration);
+
+let tarifIn: TarifIn; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tarifsCreateTarif(
+    tarifIn,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tarifIn** | **TarifIn**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Tarif**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Platform operator or parent tenant admin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **tarifsDeleteTarif**
+> tarifsDeleteTarif()
+
+Delete a tarif plan.
+
+### Example
+
+```typescript
+import {
+    Tarif,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tarif(configuration);
+
+let tarifId: string; //Public id of the tarif to delete. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tarifsDeleteTarif(
+    tarifId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tarifId** | [**string**] | Public id of the tarif to delete. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Insufficient privileges, or tariff not deletable by your tenant. |  -  |
+|**404** | No tarif exists with the given id. |  -  |
+|**409** | Tarif is the active plan for one or more tenants and cannot be deleted. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **tarifsUpdateTarif**
+> Tarif tarifsUpdateTarif(tarifIn)
+
+Update an existing tarif plan.
+
+### Example
+
+```typescript
+import {
+    Tarif,
+    Configuration,
+    TarifIn
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tarif(configuration);
+
+let tarifId: string; //Public id of the tarif to update. (default to undefined)
+let tarifIn: TarifIn; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.tarifsUpdateTarif(
+    tarifId,
+    tarifIn,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **tarifIn** | **TarifIn**|  | |
+| **tarifId** | [**string**] | Public id of the tarif to update. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Tarif**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Insufficient privileges, or tariff not editable by your tenant. |  -  |
+|**404** | No tarif exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/TarifIn.md

@@ -0,0 +1,39 @@
+# TarifIn
+
+Model for creating or updating a tarif.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name for the tarif to be created. Max 100 characters. | [default to undefined]
+**price** | **number** | The price of the tarif. This field is required. | [default to undefined]
+**hard_limit** | **number** | The hard limit to restrict the user. | [default to undefined]
+**licenses** | **number** |  | [optional] [default to undefined]
+**monthly_limit_per_license** | **number** |  | [optional] [default to undefined]
+**soft_limit_fraction** | **number** |  | [optional] [default to undefined]
+**status** | [**TarifStatusEnum**](TarifStatusEnum.md) |  | [optional] [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**is_unlimited** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TarifIn } from 'neuland-hub-sdk';
+
+const instance: TarifIn = {
+    name,
+    price,
+    hard_limit,
+    licenses,
+    monthly_limit_per_license,
+    soft_limit_fraction,
+    status,
+    expires_at,
+    description,
+    is_unlimited,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TarifStatusEnum.md

@@ -0,0 +1,11 @@
+# TarifStatusEnum
+
+Enum for Tarif status in Tarif
+
+## Enum
+
+* `ACTIVE` (value: `'ACTIVE'`)
+
+* `RETIRED` (value: `'RETIRED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)