@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/docs/UpdateTagRequest.md

@@ -0,0 +1,39 @@
+
+# UpdateTagRequest
+
+Request to update a tag.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`color` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { UpdateTagRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "color": null,
+  "description": null,
+} satisfies UpdateTagRequest
+
+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 UpdateTagRequest
+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)
+
+

package/docs/UpdateTenantRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateTenantRequest
+
+Update tenant request model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`idpConfig` | [OAuth2Config](OAuth2Config.md)
+
+## Example
+
+```typescript
+import type { UpdateTenantRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "idpConfig": null,
+} satisfies UpdateTenantRequest
+
+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 UpdateTenantRequest
+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)
+
+

package/docs/UpdateThreadRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateThreadRequest
+
+Request to update a thread.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`title` | string
+`parentThreadId` | string
+
+## Example
+
+```typescript
+import type { UpdateThreadRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "title": null,
+  "parentThreadId": null,
+} satisfies UpdateThreadRequest
+
+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 UpdateThreadRequest
+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)
+
+

package/docs/UpdateUserRequest.md

@@ -0,0 +1,34 @@
+
+# UpdateUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`defaultTenantId` | string
+
+## Example
+
+```typescript
+import type { UpdateUserRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "defaultTenantId": null,
+} satisfies UpdateUserRequest
+
+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 UpdateUserRequest
+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)
+
+

package/docs/UserPermissionsApi.md

@@ -0,0 +1,314 @@
+# UserPermissionsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createUserPermission**](UserPermissionsApi.md#createuserpermission) | **POST** /v1/user-permissions | Create User Permission Handler |
+| [**deleteUserPermission**](UserPermissionsApi.md#deleteuserpermission) | **DELETE** /v1/user-permissions/{permission_id} | Delete User Permission Handler |
+| [**listUserPermissions**](UserPermissionsApi.md#listuserpermissions) | **GET** /v1/user-permissions | List User Permissions Handler |
+| [**updateUserPermission**](UserPermissionsApi.md#updateuserpermission) | **PATCH** /v1/user-permissions/{permission_id} | Update User Permission Handler |
+
+
+
+## createUserPermission
+
+> PermissionResponse createUserPermission(createPermissionRequest, ksUat)
+
+Create User Permission Handler
+
+Create a path permission for a user in a tenant (admin/owner only).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserPermissionsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateUserPermissionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UserPermissionsApi();
+
+  const body = {
+    // CreatePermissionRequest
+    createPermissionRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateUserPermissionRequest;
+
+  try {
+    const data = await api.createUserPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createPermissionRequest** | [CreatePermissionRequest](CreatePermissionRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PermissionResponse**](PermissionResponse.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)
+
+
+## deleteUserPermission
+
+> deleteUserPermission(permissionId, tenantId, ksUat)
+
+Delete User Permission Handler
+
+Delete a path permission (admin/owner only).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserPermissionsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteUserPermissionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UserPermissionsApi();
+
+  const body = {
+    // string
+    permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Tenant ID the permission belongs to
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteUserPermissionRequest;
+
+  try {
+    const data = await api.deleteUserPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **permissionId** | `string` |  | [Defaults to `undefined`] |
+| **tenantId** | `string` | Tenant ID the permission belongs to | [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)
+
+
+## listUserPermissions
+
+> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset, ksUat)
+
+List User Permissions Handler
+
+List path permissions for a user in a tenant (admin/owner only).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserPermissionsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListUserPermissionsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UserPermissionsApi();
+
+  const body = {
+    // string | Tenant ID to list permissions for
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | User ID to list permissions for
+    userId: 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 ListUserPermissionsRequest;
+
+  try {
+    const data = await api.listUserPermissions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` | Tenant ID to list permissions for | [Defaults to `undefined`] |
+| **userId** | `string` | User ID to list permissions for | [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
+
+[**PaginatedResponsePermissionResponse**](PaginatedResponsePermissionResponse.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)
+
+
+## updateUserPermission
+
+> PermissionResponse updateUserPermission(permissionId, tenantId, updatePermissionRequest, ksUat)
+
+Update User Permission Handler
+
+Update a path permission (admin/owner only).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserPermissionsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateUserPermissionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UserPermissionsApi();
+
+  const body = {
+    // string
+    permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Tenant ID the permission belongs to
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdatePermissionRequest
+    updatePermissionRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateUserPermissionRequest;
+
+  try {
+    const data = await api.updateUserPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **permissionId** | `string` |  | [Defaults to `undefined`] |
+| **tenantId** | `string` | Tenant ID the permission belongs to | [Defaults to `undefined`] |
+| **updatePermissionRequest** | [UpdatePermissionRequest](UpdatePermissionRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PermissionResponse**](PermissionResponse.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/UserResponse.md

@@ -0,0 +1,44 @@
+
+# UserResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`idpType` | [IdpType](IdpType.md)
+`currentTenantId` | string
+`currentTenantRole` | [TenantUserRole](TenantUserRole.md)
+`defaultTenantId` | string
+
+## Example
+
+```typescript
+import type { UserResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "idpType": null,
+  "currentTenantId": null,
+  "currentTenantRole": null,
+  "defaultTenantId": null,
+} satisfies UserResponse
+
+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 UserResponse
+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)
+
+

package/docs/UsersApi.md

@@ -0,0 +1,149 @@
+# UsersApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMe**](UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler |
+| [**updateMe**](UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler |
+
+
+
+## getMe
+
+> UserResponse getMe(ksUat)
+
+Get Me Handler
+
+Get current user information including current tenant context.  Returns the authenticated user\'s profile along with their current tenant ID (from the UAT token) and default tenant ID (from user record).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '@knowledge-stack/ksapi';
+import type { GetMeRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetMeRequest;
+
+  try {
+    const data = await api.getMe(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserResponse**](UserResponse.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)
+
+
+## updateMe
+
+> UserResponse updateMe(updateUserRequest, ksUat)
+
+Update Me Handler
+
+Update the user\'s default tenant.  The user must belong to the specified tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateMeRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // UpdateUserRequest
+    updateUserRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateMeRequest;
+
+  try {
+    const data = await api.updateMe(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateUserRequest** | [UpdateUserRequest](UpdateUserRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserResponse**](UserResponse.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/ValidationError.md

@@ -0,0 +1,42 @@
+
+# ValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`loc` | [Array<LocationInner>](LocationInner.md)
+`msg` | string
+`type` | string
+`input` | any
+`ctx` | object
+
+## Example
+
+```typescript
+import type { ValidationError } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "loc": null,
+  "msg": null,
+  "type": null,
+  "input": null,
+  "ctx": null,
+} satisfies ValidationError
+
+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 ValidationError
+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)
+
+