@knowledge-stack/ksapi 1.95.4 → 1.96.0

package/docs/ProposedMemoryChunkResponse.md

@@ -0,0 +1,48 @@
+
+# ProposedMemoryChunkResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chunkId` | string
+`scope` | [MemoryScope](MemoryScope.md)
+`ownerPathPartId` | string
+`kind` | [MemoryKind](MemoryKind.md)
+`rationale` | string
+`body` | string
+`proposerTenantUserId` | string
+`runId` | string
+
+## Example
+
+```typescript
+import type { ProposedMemoryChunkResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chunkId": null,
+  "scope": null,
+  "ownerPathPartId": null,
+  "kind": null,
+  "rationale": null,
+  "body": null,
+  "proposerTenantUserId": null,
+  "runId": null,
+} satisfies ProposedMemoryChunkResponse
+
+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 ProposedMemoryChunkResponse
+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/SectionsApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createSection
 
-> SectionResponse createSection(createSectionRequest, authorization, ksUat)
+> SectionResponse createSection(createSectionRequest)
 
 Create Section Handler
 
@@ -32,15 +32,17 @@ import type { CreateSectionOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // CreateSectionRequest
     createSectionRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies CreateSectionOperationRequest;
 
   try {
@@ -61,8 +63,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createSectionRequest** | [CreateSectionRequest](CreateSectionRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -70,7 +70,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -89,7 +89,7 @@ No authorization required
 
 ## deleteSection
 
-> deleteSection(sectionId, authorization, ksUat)
+> deleteSection(sectionId)
 
 Delete Section Handler
 
@@ -106,15 +106,17 @@ import type { DeleteSectionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // string
     sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DeleteSectionRequest;
 
   try {
@@ -135,8 +137,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sectionId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -144,7 +144,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -163,7 +163,7 @@ No authorization required
 
 ## dissolveSection
 
-> DissolveSectionResponse dissolveSection(sectionId, authorization, ksUat)
+> DissolveSectionResponse dissolveSection(sectionId)
 
 Dissolve Section Handler
 
@@ -180,15 +180,17 @@ import type { DissolveSectionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // string
     sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DissolveSectionRequest;
 
   try {
@@ -209,8 +211,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sectionId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -218,7 +218,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -237,7 +237,7 @@ No authorization required
 
 ## getSection
 
-> SectionResponse getSection(sectionId, authorization, ksUat)
+> SectionResponse getSection(sectionId)
 
 Get Section Handler
 
@@ -254,15 +254,17 @@ import type { GetSectionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // string
     sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetSectionRequest;
 
   try {
@@ -283,8 +285,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sectionId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -292,7 +292,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -311,7 +311,7 @@ No authorization required
 
 ## getSectionsBulk
 
-> Array<SectionResponse> getSectionsBulk(sectionIds, authorization, ksUat)
+> Array<SectionResponse> getSectionsBulk(sectionIds)
 
 Get Sections Bulk Handler
 
@@ -328,15 +328,17 @@ import type { GetSectionsBulkRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // Array<string> | Section IDs to fetch (max 200) (optional)
     sectionIds: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetSectionsBulkRequest;
 
   try {
@@ -357,8 +359,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sectionIds** | `Array<string>` | Section IDs to fetch (max 200) | [Optional] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -366,7 +366,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -385,7 +385,7 @@ No authorization required
 
 ## updateSection
 
-> SectionResponse updateSection(sectionId, updateSectionRequest, authorization, ksUat)
+> SectionResponse updateSection(sectionId, updateSectionRequest)
 
 Update Section Handler
 
@@ -402,17 +402,19 @@ import type { UpdateSectionOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SectionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SectionsApi(config);
 
   const body = {
     // string
     sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // UpdateSectionRequest
     updateSectionRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies UpdateSectionOperationRequest;
 
   try {
@@ -434,8 +436,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **sectionId** | `string` |  | [Defaults to `undefined`] |
 | **updateSectionRequest** | [UpdateSectionRequest](UpdateSectionRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -443,7 +443,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/SubscriptionsApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## changeTenantSubscription
 
-> SubmitSubscriptionResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey, authorization, ksUat)
+> SubmitSubscriptionResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey)
 
 Change Tenant Subscription Handler
 
@@ -28,7 +28,13 @@ import type { ChangeTenantSubscriptionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SubscriptionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SubscriptionsApi(config);
 
   const body = {
     // string
@@ -37,10 +43,6 @@ async function example() {
     changeSubscriptionRequest: ...,
     // string (optional)
     idempotencyKey: idempotencyKey_example,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ChangeTenantSubscriptionRequest;
 
   try {
@@ -63,8 +65,6 @@ example().catch(console.error);
 | **tenantId** | `string` |  | [Defaults to `undefined`] |
 | **changeSubscriptionRequest** | [ChangeSubscriptionRequest](ChangeSubscriptionRequest.md) |  | |
 | **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -72,7 +72,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -91,7 +91,7 @@ No authorization required
 
 ## getTenantSubscription
 
-> SubscriptionPlanResponse getTenantSubscription(tenantId, authorization, ksUat)
+> SubscriptionPlanResponse getTenantSubscription(tenantId)
 
 Get Tenant Subscription Handler
 
@@ -108,15 +108,17 @@ import type { GetTenantSubscriptionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new SubscriptionsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SubscriptionsApi(config);
 
   const body = {
     // string
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetTenantSubscriptionRequest;
 
   try {
@@ -137,8 +139,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tenantId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -146,7 +146,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/TagsApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createTag
 
-> TagResponse createTag(createTagRequest, authorization, ksUat)
+> TagResponse createTag(createTagRequest)
 
 Create Tag Handler
 
@@ -31,15 +31,17 @@ import type { CreateTagOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new TagsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TagsApi(config);
 
   const body = {
     // CreateTagRequest
     createTagRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies CreateTagOperationRequest;
 
   try {
@@ -60,8 +62,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createTagRequest** | [CreateTagRequest](CreateTagRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -69,7 +69,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -88,7 +88,7 @@ No authorization required
 
 ## deleteTag
 
-> deleteTag(tagId, authorization, ksUat)
+> deleteTag(tagId)
 
 Delete Tag Handler
 
@@ -105,15 +105,17 @@ import type { DeleteTagRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new TagsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TagsApi(config);
 
   const body = {
     // string
     tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DeleteTagRequest;
 
   try {
@@ -134,8 +136,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tagId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -143,7 +143,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -162,7 +162,7 @@ No authorization required
 
 ## getTag
 
-> TagResponse getTag(tagId, authorization, ksUat)
+> TagResponse getTag(tagId)
 
 Get Tag Handler
 
@@ -179,15 +179,17 @@ import type { GetTagRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new TagsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TagsApi(config);
 
   const body = {
     // string
     tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetTagRequest;
 
   try {
@@ -208,8 +210,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tagId** | `string` |  | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -217,7 +217,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -236,7 +236,7 @@ No authorization required
 
 ## listTags
 
-> PaginatedResponseTagResponse listTags(limit, offset, authorization, ksUat)
+> PaginatedResponseTagResponse listTags(limit, offset)
 
 List Tags Handler
 
@@ -253,17 +253,19 @@ import type { ListTagsRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new TagsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TagsApi(config);
 
   const body = {
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
     offset: 56,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ListTagsRequest;
 
   try {
@@ -285,8 +287,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -294,7 +294,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -313,7 +313,7 @@ No authorization required
 
 ## updateTag
 
-> TagResponse updateTag(tagId, updateTagRequest, authorization, ksUat)
+> TagResponse updateTag(tagId, updateTagRequest)
 
 Update Tag Handler
 
@@ -330,17 +330,19 @@ import type { UpdateTagOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new TagsApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TagsApi(config);
 
   const body = {
     // string
     tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // UpdateTagRequest
     updateTagRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies UpdateTagOperationRequest;
 
   try {
@@ -362,8 +364,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **tagId** | `string` |  | [Defaults to `undefined`] |
 | **updateTagRequest** | [UpdateTagRequest](UpdateTagRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -371,7 +371,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers