@knowledge-stack/ksapi 1.95.3 → 1.96.0

package/docs/InvitesApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## acceptInvite
 
-> AcceptInviteResponse acceptInvite(inviteId, authorization, ksUat)
+> AcceptInviteResponse acceptInvite(inviteId)
 
 Accept Invite
 
@@ -31,15 +31,17 @@ import type { AcceptInviteRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new InvitesApi();
+  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 InvitesApi(config);
 
   const body = {
     // string | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first.
     inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies AcceptInviteRequest;
 
   try {
@@ -60,8 +62,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **inviteId** | `string` | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first. | [Defaults to `undefined`] |
-| **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
 
 ## createInvite
 
-> InviteResponse createInvite(inviteUserRequest, authorization, ksUat)
+> InviteResponse createInvite(inviteUserRequest)
 
 Create Invite
 
@@ -105,15 +105,17 @@ import type { CreateInviteRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new InvitesApi();
+  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 InvitesApi(config);
 
   const body = {
     // InviteUserRequest
     inviteUserRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies CreateInviteRequest;
 
   try {
@@ -134,8 +136,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **inviteUserRequest** | [InviteUserRequest](InviteUserRequest.md) |  | |
-| **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
 
 ## deleteInvite
 
-> deleteInvite(inviteId, authorization, ksUat)
+> deleteInvite(inviteId)
 
 Delete Invite
 
@@ -179,15 +179,17 @@ import type { DeleteInviteRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new InvitesApi();
+  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 InvitesApi(config);
 
   const body = {
     // string
     inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DeleteInviteRequest;
 
   try {
@@ -208,8 +210,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **inviteId** | `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
 
 ## listInvites
 
-> PaginatedResponseInviteResponse listInvites(email, status, limit, offset, authorization, ksUat)
+> PaginatedResponseInviteResponse listInvites(email, status, limit, offset)
 
 List Invites Handler
 
@@ -253,7 +253,13 @@ import type { ListInvitesRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new InvitesApi();
+  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 InvitesApi(config);
 
   const body = {
     // string | Filter by email (case-insensitive partial match) (optional)
@@ -264,10 +270,6 @@ async function example() {
     limit: 56,
     // number | Number of items to skip (optional)
     offset: 56,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ListInvitesRequest;
 
   try {
@@ -291,8 +293,6 @@ example().catch(console.error);
 | **status** | `InviteStatus` | Filter by invite status (pending, accepted, expired) | [Optional] [Defaults to `undefined`] [Enum: pending, accepted, expired] |
 | **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
 
@@ -300,7 +300,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -319,7 +319,7 @@ No authorization required
 
 ## updateInvite
 
-> InviteResponse updateInvite(inviteId, updateInviteRequest, authorization, ksUat)
+> InviteResponse updateInvite(inviteId, updateInviteRequest)
 
 Update Invite Handler
 
@@ -336,17 +336,19 @@ import type { UpdateInviteOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new InvitesApi();
+  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 InvitesApi(config);
 
   const body = {
     // string
     inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // UpdateInviteRequest
     updateInviteRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies UpdateInviteOperationRequest;
 
   try {
@@ -368,8 +370,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **inviteId** | `string` |  | [Defaults to `undefined`] |
 | **updateInviteRequest** | [UpdateInviteRequest](UpdateInviteRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -377,7 +377,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/ItemPermissions.md

@@ -0,0 +1,41 @@
+
+# ItemPermissions
+
+Caller\'s authorization on an item: whether an action is permitted.  Authorization only — not whether it will currently succeed. An authorized write/delete can still be refused by transient state on the same response: a run\'s ``execution_state`` (e.g. not IN_PROGRESS to delete), a ``system_managed`` item, or a document that is ``approval_state``-sealed or checked out by another user (see authorization.md §5.6). Ladder: ``can_delete`` ⟹ ``can_write`` ⟹ ``can_read``; ``can_approve`` is orthogonal and always false for agents.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`canRead` | boolean
+`canWrite` | boolean
+`canDelete` | boolean
+`canApprove` | boolean
+
+## Example
+
+```typescript
+import type { ItemPermissions } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "canRead": null,
+  "canWrite": null,
+  "canDelete": null,
+  "canApprove": null,
+} satisfies ItemPermissions
+
+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 ItemPermissions
+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/MemoryApi.md

@@ -0,0 +1,379 @@
+# MemoryApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**approveMemoryProposal**](MemoryApi.md#approvememoryproposal) | **POST** /v1/memory/proposals/{chunk_id}/approve | Approve Memory Proposal Handler |
+| [**getMemoryBody**](MemoryApi.md#getmemorybody) | **GET** /v1/memory/body | Get Memory Body Handler |
+| [**listMemoryProposals**](MemoryApi.md#listmemoryproposals) | **GET** /v1/memory/proposals | List Memory Proposals Handler |
+| [**proposeMemoryChunk**](MemoryApi.md#proposememorychunkoperation) | **POST** /v1/memory/proposals | Propose Memory Chunk Handler |
+| [**rejectMemoryProposal**](MemoryApi.md#rejectmemoryproposal) | **POST** /v1/memory/proposals/{chunk_id}/reject | Reject Memory Proposal Handler |
+
+
+
+## approveMemoryProposal
+
+> MemoryChunkResponse approveMemoryProposal(chunkId)
+
+Approve Memory Proposal Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemoryApi,
+} from '@knowledge-stack/ksapi';
+import type { ApproveMemoryProposalRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  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 MemoryApi(config);
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ApproveMemoryProposalRequest;
+
+  try {
+    const data = await api.approveMemoryProposal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**MemoryChunkResponse**](MemoryChunkResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## getMemoryBody
+
+> MemoryBodyResponse getMemoryBody(scope, ownerId)
+
+Get Memory Body Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemoryApi,
+} from '@knowledge-stack/ksapi';
+import type { GetMemoryBodyRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  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 MemoryApi(config);
+
+  const body = {
+    // MemoryScope
+    scope: ...,
+    // string
+    ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetMemoryBodyRequest;
+
+  try {
+    const data = await api.getMemoryBody(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scope** | `MemoryScope` |  | [Defaults to `undefined`] [Enum: user, workflow] |
+| **ownerId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**MemoryBodyResponse**](MemoryBodyResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## listMemoryProposals
+
+> PaginatedResponsePendingMemoryChunkResponse listMemoryProposals(limit, offset)
+
+List Memory Proposals Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemoryApi,
+} from '@knowledge-stack/ksapi';
+import type { ListMemoryProposalsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  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 MemoryApi(config);
+
+  const body = {
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+  } satisfies ListMemoryProposalsRequest;
+
+  try {
+    const data = await api.listMemoryProposals(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`] |
+
+### Return type
+
+[**PaginatedResponsePendingMemoryChunkResponse**](PaginatedResponsePendingMemoryChunkResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## proposeMemoryChunk
+
+> ProposedMemoryChunkResponse proposeMemoryChunk(proposeMemoryChunkRequest)
+
+Propose Memory Chunk Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemoryApi,
+} from '@knowledge-stack/ksapi';
+import type { ProposeMemoryChunkOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  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 MemoryApi(config);
+
+  const body = {
+    // ProposeMemoryChunkRequest
+    proposeMemoryChunkRequest: ...,
+  } satisfies ProposeMemoryChunkOperationRequest;
+
+  try {
+    const data = await api.proposeMemoryChunk(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **proposeMemoryChunkRequest** | [ProposeMemoryChunkRequest](ProposeMemoryChunkRequest.md) |  | |
+
+### Return type
+
+[**ProposedMemoryChunkResponse**](ProposedMemoryChunkResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## rejectMemoryProposal
+
+> rejectMemoryProposal(chunkId)
+
+Reject Memory Proposal Handler
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemoryApi,
+} from '@knowledge-stack/ksapi';
+import type { RejectMemoryProposalRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  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 MemoryApi(config);
+
+  const body = {
+    // string
+    chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RejectMemoryProposalRequest;
+
+  try {
+    const data = await api.rejectMemoryProposal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **chunkId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+

package/docs/MemoryBodyResponse.md

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