@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/TenantsApi.md

@@ -0,0 +1,605 @@
+# TenantsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTenant**](TenantsApi.md#createtenantoperation) | **POST** /v1/tenants | Create Tenant |
+| [**deleteTenant**](TenantsApi.md#deletetenant) | **DELETE** /v1/tenants/{tenant_id} | Delete Tenant |
+| [**deleteTenantUser**](TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User |
+| [**getTenant**](TenantsApi.md#gettenant) | **GET** /v1/tenants/{tenant_id} | Get Tenant |
+| [**listTenantUsers**](TenantsApi.md#listtenantusers) | **GET** /v1/tenants/{tenant_id}/users | List Tenant Users |
+| [**listTenants**](TenantsApi.md#listtenants) | **GET** /v1/tenants | List Tenants |
+| [**updateTenant**](TenantsApi.md#updatetenantoperation) | **PATCH** /v1/tenants/{tenant_id} | Update Tenant |
+| [**updateTenantUser**](TenantsApi.md#updatetenantuser) | **PATCH** /v1/tenants/{tenant_id}/users/{user_id} | Update Tenant User |
+
+
+
+## createTenant
+
+> TenantResponse createTenant(createTenantRequest, ksUat)
+
+Create Tenant
+
+Create a new tenant.  The creator is automatically added as OWNER of the tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateTenantOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // CreateTenantRequest
+    createTenantRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateTenantOperationRequest;
+
+  try {
+    const data = await api.createTenant(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createTenantRequest** | [CreateTenantRequest](CreateTenantRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteTenant
+
+> deleteTenant(tenantId, ksUat)
+
+Delete Tenant
+
+Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteTenantRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteTenantRequest;
+
+  try {
+    const data = await api.deleteTenant(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteTenantUser
+
+> deleteTenantUser(tenantId, userId, ksUat)
+
+Delete Tenant User
+
+Remove a user from a tenant.  Requires OWNER or ADMIN role. Cannot remove the tenant owner.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteTenantUserRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteTenantUserRequest;
+
+  try {
+    const data = await api.deleteTenantUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getTenant
+
+> TenantResponse getTenant(tenantId, ksUat)
+
+Get Tenant
+
+Get tenant information by ID.  User must be a member of the tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTenantRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetTenantRequest;
+
+  try {
+    const data = await api.getTenant(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTenantUsers
+
+> PaginatedResponseTenantUserResponse listTenantUsers(tenantId, limit, offset, ksUat)
+
+List Tenant Users
+
+List members of a tenant with pagination.  Requires OWNER or ADMIN membership in the tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListTenantUsersRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListTenantUsersRequest;
+
+  try {
+    const data = await api.listTenantUsers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseTenantUserResponse**](PaginatedResponseTenantUserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTenants
+
+> PaginatedResponseTenantResponse listTenants(limit, offset, ksUat)
+
+List Tenants
+
+List all tenants the current user belongs to.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListTenantsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListTenantsRequest;
+
+  try {
+    const data = await api.listTenants(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseTenantResponse**](PaginatedResponseTenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateTenant
+
+> TenantResponse updateTenant(tenantId, updateTenantRequest, ksUat)
+
+Update Tenant
+
+Update tenant configuration.  Requires OWNER or ADMIN role in the tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateTenantOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateTenantRequest
+    updateTenantRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateTenantOperationRequest;
+
+  try {
+    const data = await api.updateTenant(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **updateTenantRequest** | [UpdateTenantRequest](UpdateTenantRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateTenantUser
+
+> TenantUserResponse updateTenantUser(tenantId, userId, tenantUserEditRequest, ksUat)
+
+Update Tenant User
+
+Update a user\'s role in a tenant.  Requires OWNER or ADMIN role. Cannot create a duplicate owner.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateTenantUserRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // TenantUserEditRequest
+    tenantUserEditRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateTenantUserRequest;
+
+  try {
+    const data = await api.updateTenantUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **tenantUserEditRequest** | [TenantUserEditRequest](TenantUserEditRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantUserResponse**](TenantUserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/ThreadMessageResponse.md

@@ -0,0 +1,53 @@
+
+# ThreadMessageResponse
+
+Thread message response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`sequence` | number
+`role` | [MessageRole](MessageRole.md)
+`content` | { [key: string]: any; }
+`parentPathId` | string
+`materializedPath` | string
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ThreadMessageResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "sequence": null,
+  "role": null,
+  "content": null,
+  "parentPathId": null,
+  "materializedPath": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ThreadMessageResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ThreadMessageResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+