@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/docs/PaginatedResponseDocumentVersionResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseDocumentVersionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<DocumentVersionResponse>](DocumentVersionResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseDocumentVersionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseDocumentVersionResponse
+
+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 PaginatedResponseDocumentVersionResponse
+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/PaginatedResponseFolderResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseFolderResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<FolderResponse>](FolderResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseFolderResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseFolderResponse
+
+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 PaginatedResponseFolderResponse
+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/PaginatedResponseInviteResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseInviteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<InviteResponse>](InviteResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseInviteResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseInviteResponse
+
+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 PaginatedResponseInviteResponse
+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/PaginatedResponsePathPartResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponsePathPartResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<PathPartResponse>](PathPartResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponsePathPartResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponsePathPartResponse
+
+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 PaginatedResponsePathPartResponse
+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/PaginatedResponsePermissionResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponsePermissionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<PermissionResponse>](PermissionResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponsePermissionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponsePermissionResponse
+
+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 PaginatedResponsePermissionResponse
+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/PaginatedResponseTagResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseTagResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<TagResponse>](TagResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseTagResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseTagResponse
+
+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 PaginatedResponseTagResponse
+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/PaginatedResponseTenantResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseTenantResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<TenantResponse>](TenantResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseTenantResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseTenantResponse
+
+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 PaginatedResponseTenantResponse
+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/PaginatedResponseTenantUserResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseTenantUserResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<TenantUserResponse>](TenantUserResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseTenantUserResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseTenantUserResponse
+
+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 PaginatedResponseTenantUserResponse
+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/PaginatedResponseThreadMessageResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseThreadMessageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ThreadMessageResponse>](ThreadMessageResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseThreadMessageResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseThreadMessageResponse
+
+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 PaginatedResponseThreadMessageResponse
+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/PaginatedResponseThreadResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseThreadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<ThreadResponse>](ThreadResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseThreadResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseThreadResponse
+
+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 PaginatedResponseThreadResponse
+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/PaginatedResponseWorkflowSummaryResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseWorkflowSummaryResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<WorkflowSummaryResponse>](WorkflowSummaryResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseWorkflowSummaryResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseWorkflowSummaryResponse
+
+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 PaginatedResponseWorkflowSummaryResponse
+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/PartType.md

@@ -0,0 +1,33 @@
+
+# PartType
+
+Type of path part in the filesystem.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PartType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PartType
+
+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 PartType
+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/PasswordResetRequest.md

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

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

@@ -0,0 +1,33 @@
+
+# PathOrder
+
+Ordering strategy for path traversal results.  - LOGICAL: Use prev/next_sibling_path_part_id linked list order per depth level - NAME: Alphabetical by path_part.name (DEFAULT) - UPDATED_AT: By updated_at timestamp (most recent first) - CREATED_AT: By created_at timestamp (oldest first)
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PathOrder } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PathOrder
+
+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 PathOrder
+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/PathPartResponse.md

@@ -0,0 +1,53 @@
+
+# PathPartResponse
+
+Generic path part response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`name` | string
+`partType` | [PartType](PartType.md)
+`parentPathId` | string
+`metadataObjId` | string
+`materializedPath` | string
+`systemManaged` | boolean
+`tags` | [Array<TagResponse>](TagResponse.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { PathPartResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "name": null,
+  "partType": null,
+  "parentPathId": null,
+  "metadataObjId": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tags": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies PathPartResponse
+
+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 PathPartResponse
+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/PathPartTagsResponse.md

@@ -0,0 +1,35 @@
+
+# PathPartTagsResponse
+
+Response containing the current tags for a path part.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tags` | [Array<TagResponse>](TagResponse.md)
+
+## Example
+
+```typescript
+import type { PathPartTagsResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tags": null,
+} satisfies PathPartTagsResponse
+
+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 PathPartTagsResponse
+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)
+
+