@knowledge-stack/ksapi 1.41.0 → 1.42.0

package/docs/ApiKeyResponse.md

@@ -0,0 +1,41 @@
+
+# ApiKeyResponse
+
+API key metadata (without the secret key).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`keySuffix` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKeyResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "keySuffix": null,
+  "createdAt": null,
+} satisfies ApiKeyResponse
+
+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 ApiKeyResponse
+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/ApiKeysApi.md

@@ -0,0 +1,293 @@
+# ApiKeysApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createApiKey**](ApiKeysApi.md#createapikeyoperation) | **POST** /v1/api-keys | Create Api Key Handler |
+| [**deleteApiKey**](ApiKeysApi.md#deleteapikey) | **DELETE** /v1/api-keys/{api_key_id} | Delete Api Key Handler |
+| [**getApiKey**](ApiKeysApi.md#getapikey) | **GET** /v1/api-keys/{api_key_id} | Get Api Key Handler |
+| [**listApiKeys**](ApiKeysApi.md#listapikeys) | **GET** /v1/api-keys | List Api Keys Handler |
+
+
+
+## createApiKey
+
+> CreateApiKeyResponse createApiKey(createApiKeyRequest, ksUat)
+
+Create Api Key Handler
+
+Create a new API key. The full key is returned only once.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateApiKeyOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ApiKeysApi();
+
+  const body = {
+    // CreateApiKeyRequest
+    createApiKeyRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateApiKeyOperationRequest;
+
+  try {
+    const data = await api.createApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createApiKeyRequest** | [CreateApiKeyRequest](CreateApiKeyRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**CreateApiKeyResponse**](CreateApiKeyResponse.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)
+
+
+## deleteApiKey
+
+> deleteApiKey(apiKeyId, ksUat)
+
+Delete Api Key Handler
+
+Delete an API key.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteApiKeyRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ApiKeysApi();
+
+  const body = {
+    // string
+    apiKeyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteApiKeyRequest;
+
+  try {
+    const data = await api.deleteApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiKeyId** | `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)
+
+
+## getApiKey
+
+> ApiKeyResponse getApiKey(apiKeyId, ksUat)
+
+Get Api Key Handler
+
+Get a single API key by ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@knowledge-stack/ksapi';
+import type { GetApiKeyRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ApiKeysApi();
+
+  const body = {
+    // string
+    apiKeyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetApiKeyRequest;
+
+  try {
+    const data = await api.getApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiKeyId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.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)
+
+
+## listApiKeys
+
+> Array<ApiKeyResponse> listApiKeys(ksUat)
+
+List Api Keys Handler
+
+List all API keys for the current user.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@knowledge-stack/ksapi';
+import type { ListApiKeysRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ApiKeysApi();
+
+  const body = {
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListApiKeysRequest;
+
+  try {
+    const data = await api.listApiKeys(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
+
+[**Array<ApiKeyResponse>**](ApiKeyResponse.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)
+

package/docs/AuthApi.md

@@ -375,7 +375,7 @@ No authorization required
 
 ## refreshUat
 
-> UserResponse refreshUat(tenantId, ksUat)
+> UserResponse refreshUat(tenantId, authorization, ksUat)
 
 Refresh Uat Handler
 
@@ -398,6 +398,8 @@ async function example() {
     // string | Target tenant ID to switch to. None=refresh current tenant (optional)
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies RefreshUatRequest;
 
@@ -419,6 +421,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tenantId** | `string` | Target tenant ID to switch to. None=refresh current tenant | [Optional] [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -446,7 +449,7 @@ No authorization required
 
 ## resetPassword
 
-> UserResponse resetPassword(passwordResetRequest, ksUat)
+> UserResponse resetPassword(passwordResetRequest, authorization, ksUat)
 
 Reset Password Handler
 
@@ -469,6 +472,8 @@ async function example() {
     // PasswordResetRequest
     passwordResetRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies ResetPasswordRequest;
 
@@ -490,6 +495,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **passwordResetRequest** | [PasswordResetRequest](PasswordResetRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type

package/docs/ChunkLineagesApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createChunkLineage
 
-> Array<ChunkLineageResponse> createChunkLineage(createChunkLineageRequest, ksUat)
+> Array<ChunkLineageResponse> createChunkLineage(createChunkLineageRequest, authorization, ksUat)
 
 Create Chunk Lineage Handler
 
@@ -35,6 +35,8 @@ async function example() {
     // CreateChunkLineageRequest
     createChunkLineageRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies CreateChunkLineageOperationRequest;
 
@@ -56,6 +58,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createChunkLineageRequest** | [CreateChunkLineageRequest](CreateChunkLineageRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -83,7 +86,7 @@ No authorization required
 
 ## deleteChunkLineage
 
-> deleteChunkLineage(parentChunkId, chunkId, ksUat)
+> deleteChunkLineage(parentChunkId, chunkId, authorization, ksUat)
 
 Delete Chunk Lineage Handler
 
@@ -108,6 +111,8 @@ async function example() {
     // string | Child chunk ID
     chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies DeleteChunkLineageRequest;
 
@@ -130,6 +135,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **parentChunkId** | `string` | Parent chunk ID | [Defaults to `undefined`] |
 | **chunkId** | `string` | Child chunk ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -157,7 +163,7 @@ No authorization required
 
 ## getChunkLineage
 
-> LineageGraphResponse getChunkLineage(chunkId, maxDepth, ksUat)
+> LineageGraphResponse getChunkLineage(chunkId, maxDepth, authorization, ksUat)
 
 Get Chunk Lineage Handler
 
@@ -182,6 +188,8 @@ async function example() {
     // number (optional)
     maxDepth: 56,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies GetChunkLineageRequest;
 
@@ -204,6 +212,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
 | **maxDepth** | `number` |  | [Optional] [Defaults to `3`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type

package/docs/ChunksApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createChunk
 
-> ChunkResponse createChunk(createChunkRequest, ksUat)
+> ChunkResponse createChunk(createChunkRequest, authorization, ksUat)
 
 Create Chunk Handler
 
@@ -40,6 +40,8 @@ async function example() {
     // CreateChunkRequest
     createChunkRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies CreateChunkOperationRequest;
 
@@ -61,6 +63,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createChunkRequest** | [CreateChunkRequest](CreateChunkRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -88,7 +91,7 @@ No authorization required
 
 ## deleteChunk
 
-> deleteChunk(chunkId, ksUat)
+> deleteChunk(chunkId, authorization, ksUat)
 
 Delete Chunk Handler
 
@@ -111,6 +114,8 @@ async function example() {
     // string
     chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies DeleteChunkRequest;
 
@@ -132,6 +137,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -159,7 +165,7 @@ No authorization required
 
 ## getChunk
 
-> ChunkResponse getChunk(chunkId, withDocument, ksUat)
+> ChunkResponse getChunk(chunkId, withDocument, authorization, ksUat)
 
 Get Chunk Handler
 
@@ -184,6 +190,8 @@ async function example() {
     // boolean | Include ancestor document_id and document_version_id (default: false) (optional)
     withDocument: true,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies GetChunkRequest;
 
@@ -206,6 +214,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
 | **withDocument** | `boolean` | Include ancestor document_id and document_version_id (default: false) | [Optional] [Defaults to `false`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -233,7 +242,7 @@ No authorization required
 
 ## getChunksBulk
 
-> Array<ChunkBulkResponse> getChunksBulk(chunkIds, ksUat)
+> Array<ChunkBulkResponse> getChunksBulk(chunkIds, authorization, ksUat)
 
 Get Chunks Bulk Handler
 
@@ -256,6 +265,8 @@ async function example() {
     // Array<string> | Chunk IDs to resolve (max 200) (optional)
     chunkIds: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies GetChunksBulkRequest;
 
@@ -277,6 +288,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **chunkIds** | `Array<string>` | Chunk IDs to resolve (max 200) | [Optional] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -304,7 +316,7 @@ No authorization required
 
 ## getVersionChunkIds
 
-> VersionChunkIdsResponse getVersionChunkIds(documentVersionId, ksUat)
+> VersionChunkIdsResponse getVersionChunkIds(documentVersionId, authorization, ksUat)
 
 Get Version Chunk Ids Handler
 
@@ -327,6 +339,8 @@ async function example() {
     // string | Document version ID
     documentVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies GetVersionChunkIdsRequest;
 
@@ -348,6 +362,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **documentVersionId** | `string` | Document version ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -375,7 +390,7 @@ No authorization required
 
 ## searchChunks
 
-> Array&lt;ScoredChunkResponse&gt; searchChunks(chunkSearchRequest, ksUat)
+> Array&lt;ScoredChunkResponse&gt; searchChunks(chunkSearchRequest, authorization, ksUat)
 
 Search Chunks Handler
 
@@ -398,6 +413,8 @@ async function example() {
     // ChunkSearchRequest
     chunkSearchRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies SearchChunksRequest;
 
@@ -419,6 +436,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **chunkSearchRequest** | [ChunkSearchRequest](ChunkSearchRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -446,7 +464,7 @@ No authorization required
 
 ## updateChunkContent
 
-> ChunkResponse updateChunkContent(chunkId, updateChunkContentRequest, ksUat)
+> ChunkResponse updateChunkContent(chunkId, updateChunkContentRequest, authorization, ksUat)
 
 Update Chunk Content Handler
 
@@ -471,6 +489,8 @@ async function example() {
     // UpdateChunkContentRequest
     updateChunkContentRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies UpdateChunkContentOperationRequest;
 
@@ -493,6 +513,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
 | **updateChunkContentRequest** | [UpdateChunkContentRequest](UpdateChunkContentRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -520,7 +541,7 @@ No authorization required
 
 ## updateChunkMetadata
 
-> ChunkResponse updateChunkMetadata(chunkId, updateChunkMetadataRequest, ksUat)
+> ChunkResponse updateChunkMetadata(chunkId, updateChunkMetadataRequest, authorization, ksUat)
 
 Update Chunk Metadata Handler
 
@@ -545,6 +566,8 @@ async function example() {
     // UpdateChunkMetadataRequest
     updateChunkMetadataRequest: ...,
     // string (optional)
+    authorization: authorization_example,
+    // string (optional)
     ksUat: ksUat_example,
   } satisfies UpdateChunkMetadataOperationRequest;
 
@@ -567,6 +590,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **chunkId** | `string` |  | [Defaults to `undefined`] |
 | **updateChunkMetadataRequest** | [UpdateChunkMetadataRequest](UpdateChunkMetadataRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type

package/docs/CreateApiKeyRequest.md

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