@knowledge-stack/ksapi 3.11.0 → 3.13.0

package/dist/models/TenantUserJoinMethod.js

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantUserJoinMethod = void 0;
+exports.instanceOfTenantUserJoinMethod = instanceOfTenantUserJoinMethod;
+exports.TenantUserJoinMethodFromJSON = TenantUserJoinMethodFromJSON;
+exports.TenantUserJoinMethodFromJSONTyped = TenantUserJoinMethodFromJSONTyped;
+exports.TenantUserJoinMethodToJSON = TenantUserJoinMethodToJSON;
+exports.TenantUserJoinMethodToJSONTyped = TenantUserJoinMethodToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.TenantUserJoinMethod = {
+    Creator: 'CREATOR',
+    Invited: 'INVITED',
+    Added: 'ADDED'
+};
+function instanceOfTenantUserJoinMethod(value) {
+    for (const key in exports.TenantUserJoinMethod) {
+        if (Object.prototype.hasOwnProperty.call(exports.TenantUserJoinMethod, key)) {
+            if (exports.TenantUserJoinMethod[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function TenantUserJoinMethodFromJSON(json) {
+    return TenantUserJoinMethodFromJSONTyped(json, false);
+}
+function TenantUserJoinMethodFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function TenantUserJoinMethodToJSON(value) {
+    return value;
+}
+function TenantUserJoinMethodToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/UserResponse.d.ts

@@ -9,8 +9,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { TenantUserJoinMethod } from './TenantUserJoinMethod';
 import type { IdpType } from './IdpType';
 import type { TenantUserRole } from './TenantUserRole';
+import type { OnboardingState } from './OnboardingState';
+import type { UserInfo } from './UserInfo';
+import type { AddedBy } from './AddedBy';
 /**
  *
  * @export
@@ -101,6 +105,42 @@ export interface UserResponse {
      * @memberof UserResponse
      */
     onboardingCompletedAt?: Date | null;
+    /**
+     *
+     * @type {TenantUserJoinMethod}
+     * @memberof UserResponse
+     */
+    joinMethod: TenantUserJoinMethod;
+    /**
+     * Resume step and guide progress for the current membership.
+     * @type {OnboardingState}
+     * @memberof UserResponse
+     */
+    onboardingState?: OnboardingState | null;
+    /**
+     * Who sent the accepted invite that created the current membership. NULL when the membership did not come from an email invite, and on the sign-in and sign-up responses; read it from GET /v1/users/me.
+     * @type {UserInfo}
+     * @memberof UserResponse
+     */
+    invitedBy?: UserInfo | null;
+    /**
+     *
+     * @type {AddedBy}
+     * @memberof UserResponse
+     */
+    addedBy?: AddedBy;
+    /**
+     * Profile fields the identity provider overwrites on every sync, so clients render them read-only. Empty unless directory-managed.
+     * @type {Array<string>}
+     * @memberof UserResponse
+     */
+    idpManagedFields?: Array<string>;
+    /**
+     * The current tenant's onboarding switch: true forces the flow on, false hides it, NULL follows the deployment default.
+     * @type {boolean}
+     * @memberof UserResponse
+     */
+    onboardingEnabled?: boolean | null;
 }
 export declare const UserResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/UserResponse.js

@@ -19,8 +19,12 @@ exports.UserResponseFromJSON = UserResponseFromJSON;
 exports.UserResponseFromJSONTyped = UserResponseFromJSONTyped;
 exports.UserResponseToJSON = UserResponseToJSON;
 exports.UserResponseToJSONTyped = UserResponseToJSONTyped;
+const TenantUserJoinMethod_1 = require("./TenantUserJoinMethod");
 const IdpType_1 = require("./IdpType");
 const TenantUserRole_1 = require("./TenantUserRole");
+const OnboardingState_1 = require("./OnboardingState");
+const UserInfo_1 = require("./UserInfo");
+const AddedBy_1 = require("./AddedBy");
 exports.UserResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the UserResponse interface.
@@ -42,6 +46,8 @@ function instanceOfUserResponse(value) {
         return false;
     if (!('defaultTenantId' in value) || value['defaultTenantId'] === undefined)
         return false;
+    if (!('joinMethod' in value) || value['joinMethod'] === undefined)
+        return false;
     return true;
 }
 function UserResponseFromJSON(json) {
@@ -66,6 +72,12 @@ function UserResponseFromJSONTyped(json, ignoreDiscriminator) {
         'bio': json['bio'] == null ? undefined : json['bio'],
         'avatarUrl': json['avatar_url'] == null ? undefined : json['avatar_url'],
         'onboardingCompletedAt': json['onboarding_completed_at'] == null ? undefined : (new Date(json['onboarding_completed_at'])),
+        'joinMethod': (0, TenantUserJoinMethod_1.TenantUserJoinMethodFromJSON)(json['join_method']),
+        'onboardingState': json['onboarding_state'] == null ? undefined : (0, OnboardingState_1.OnboardingStateFromJSON)(json['onboarding_state']),
+        'invitedBy': json['invited_by'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['invited_by']),
+        'addedBy': json['added_by'] == null ? undefined : (0, AddedBy_1.AddedByFromJSON)(json['added_by']),
+        'idpManagedFields': json['idp_managed_fields'] == null ? undefined : json['idp_managed_fields'],
+        'onboardingEnabled': json['onboarding_enabled'] == null ? undefined : json['onboarding_enabled'],
     };
 }
 function UserResponseToJSON(json) {
@@ -90,5 +102,11 @@ function UserResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'bio': value['bio'],
         'avatar_url': value['avatarUrl'],
         'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
+        'join_method': (0, TenantUserJoinMethod_1.TenantUserJoinMethodToJSON)(value['joinMethod']),
+        'onboarding_state': (0, OnboardingState_1.OnboardingStateToJSON)(value['onboardingState']),
+        'invited_by': (0, UserInfo_1.UserInfoToJSON)(value['invitedBy']),
+        'added_by': (0, AddedBy_1.AddedByToJSON)(value['addedBy']),
+        'idp_managed_fields': value['idpManagedFields'],
+        'onboarding_enabled': value['onboardingEnabled'],
     };
 }

package/dist/models/index.d.ts

@@ -1,8 +1,10 @@
 export * from './AcceptDisclaimerRequest';
 export * from './AcceptInviteResponse';
 export * from './AccessCheckResponse';
+export * from './AccessRequestResponse';
 export * from './ActivateSkillVersionRequest';
 export * from './AddMemberRequest';
+export * from './AddedBy';
 export * from './AncestryResponse';
 export * from './ApiAuthConfig';
 export * from './ApiConnectionRequestRequest';
@@ -156,6 +158,9 @@ export * from './GroupMemberOrder';
 export * from './GroupPermissionOrder';
 export * from './GroupPermissionResponse';
 export * from './GroupResponse';
+export * from './GuideModuleProgress';
+export * from './GuideModuleStatus';
+export * from './GuideModules';
 export * from './HTTPValidationError';
 export * from './HealthCheckResponse';
 export * from './HourHistogramResponse';
@@ -175,6 +180,9 @@ export * from './InstructionSnapshot';
 export * from './InviteLinkSettingsRequest';
 export * from './InviteLinkSettingsResponse';
 export * from './InviteOrder';
+export * from './InvitePreviewResponse';
+export * from './InvitePreviewState';
+export * from './InviteRejection';
 export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
@@ -201,8 +209,9 @@ export * from './ModelTableRequest';
 export * from './ModelTableResult';
 export * from './NetworkClass';
 export * from './NonFilesystemReferenceType';
-export * from './OnboardingCompanyRequest';
-export * from './OnboardingProfileRequest';
+export * from './OnboardingState';
+export * from './OnboardingStateUpdate';
+export * from './OnboardingStep';
 export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat';
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseBillingPaymentResponse';
@@ -286,6 +295,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SheetVisibilityChange';
 export * from './SignInRequest';
+export * from './SignUpResponse';
 export * from './SkillFile';
 export * from './SkillOrder';
 export * from './SkillResponse';
@@ -319,6 +329,7 @@ export * from './TenantSettingsResponse';
 export * from './TenantSettingsUpdate';
 export * from './TenantSubscriptionResponse';
 export * from './TenantUserEditRequest';
+export * from './TenantUserJoinMethod';
 export * from './TenantUserOrder';
 export * from './TenantUserResponse';
 export * from './TenantUserRole';

package/dist/models/index.js

@@ -19,8 +19,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AcceptDisclaimerRequest"), exports);
 __exportStar(require("./AcceptInviteResponse"), exports);
 __exportStar(require("./AccessCheckResponse"), exports);
+__exportStar(require("./AccessRequestResponse"), exports);
 __exportStar(require("./ActivateSkillVersionRequest"), exports);
 __exportStar(require("./AddMemberRequest"), exports);
+__exportStar(require("./AddedBy"), exports);
 __exportStar(require("./AncestryResponse"), exports);
 __exportStar(require("./ApiAuthConfig"), exports);
 __exportStar(require("./ApiConnectionRequestRequest"), exports);
@@ -174,6 +176,9 @@ __exportStar(require("./GroupMemberOrder"), exports);
 __exportStar(require("./GroupPermissionOrder"), exports);
 __exportStar(require("./GroupPermissionResponse"), exports);
 __exportStar(require("./GroupResponse"), exports);
+__exportStar(require("./GuideModuleProgress"), exports);
+__exportStar(require("./GuideModuleStatus"), exports);
+__exportStar(require("./GuideModules"), exports);
 __exportStar(require("./HTTPValidationError"), exports);
 __exportStar(require("./HealthCheckResponse"), exports);
 __exportStar(require("./HourHistogramResponse"), exports);
@@ -193,6 +198,9 @@ __exportStar(require("./InstructionSnapshot"), exports);
 __exportStar(require("./InviteLinkSettingsRequest"), exports);
 __exportStar(require("./InviteLinkSettingsResponse"), exports);
 __exportStar(require("./InviteOrder"), exports);
+__exportStar(require("./InvitePreviewResponse"), exports);
+__exportStar(require("./InvitePreviewState"), exports);
+__exportStar(require("./InviteRejection"), exports);
 __exportStar(require("./InviteResponse"), exports);
 __exportStar(require("./InviteStatus"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
@@ -219,8 +227,9 @@ __exportStar(require("./ModelTableRequest"), exports);
 __exportStar(require("./ModelTableResult"), exports);
 __exportStar(require("./NetworkClass"), exports);
 __exportStar(require("./NonFilesystemReferenceType"), exports);
-__exportStar(require("./OnboardingCompanyRequest"), exports);
-__exportStar(require("./OnboardingProfileRequest"), exports);
+__exportStar(require("./OnboardingState"), exports);
+__exportStar(require("./OnboardingStateUpdate"), exports);
+__exportStar(require("./OnboardingStep"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseBillingPaymentResponse"), exports);
@@ -304,6 +313,7 @@ __exportStar(require("./SetApprovalStateRequest"), exports);
 __exportStar(require("./SetWorkflowRunApprovalRequest"), exports);
 __exportStar(require("./SheetVisibilityChange"), exports);
 __exportStar(require("./SignInRequest"), exports);
+__exportStar(require("./SignUpResponse"), exports);
 __exportStar(require("./SkillFile"), exports);
 __exportStar(require("./SkillOrder"), exports);
 __exportStar(require("./SkillResponse"), exports);
@@ -337,6 +347,7 @@ __exportStar(require("./TenantSettingsResponse"), exports);
 __exportStar(require("./TenantSettingsUpdate"), exports);
 __exportStar(require("./TenantSubscriptionResponse"), exports);
 __exportStar(require("./TenantUserEditRequest"), exports);
+__exportStar(require("./TenantUserJoinMethod"), exports);
 __exportStar(require("./TenantUserOrder"), exports);
 __exportStar(require("./TenantUserResponse"), exports);
 __exportStar(require("./TenantUserRole"), exports);

package/docs/{OnboardingCompanyRequest.md → AccessRequestResponse.md}

@@ -1,25 +1,22 @@
 
-# OnboardingCompanyRequest
+# AccessRequestResponse
 
-Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`description` | string
-`industry` | string
+`requestedAt` | Date
 
 ## Example
 
 ```typescript
-import type { OnboardingCompanyRequest } from '@knowledge-stack/ksapi'
+import type { AccessRequestResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "description": null,
-  "industry": null,
-} satisfies OnboardingCompanyRequest
+  "requestedAt": null,
+} satisfies AccessRequestResponse
 
 console.log(example)
 
@@ -28,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as OnboardingCompanyRequest
+const exampleParsed = JSON.parse(exampleJSON) as AccessRequestResponse
 console.log(exampleParsed)
 ```
 

package/docs/{OnboardingProfileRequest.md → AddedBy.md}

@@ -1,27 +1,20 @@
 
-# OnboardingProfileRequest
+# AddedBy
 
-Step 2 of onboarding — per-user info for the current tenant.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`firstName` | string
-`lastName` | string
-`jobTitle` | string
 
 ## Example
 
 ```typescript
-import type { OnboardingProfileRequest } from '@knowledge-stack/ksapi'
+import type { AddedBy } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-  "firstName": null,
-  "lastName": null,
-  "jobTitle": null,
-} satisfies OnboardingProfileRequest
+} satisfies AddedBy
 
 console.log(example)
 
@@ -30,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as OnboardingProfileRequest
+const exampleParsed = JSON.parse(exampleJSON) as AddedBy
 console.log(exampleParsed)
 ```
 

package/docs/AuthApi.md

@@ -102,7 +102,7 @@ example().catch(console.error);
 
 ## createPasswordUser
 
-> UserResponse createPasswordUser(createPasswordUserRequest)
+> SignUpResponse createPasswordUser(createPasswordUserRequest)
 
 Create Password User Handler
 
@@ -145,7 +145,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**UserResponse**](UserResponse.md)
+[**SignUpResponse**](SignUpResponse.md)
 
 ### Authorization
 
@@ -388,7 +388,7 @@ No authorization required
 
 ## initiateSso
 
-> SSOInitiateResponse initiateSso(provider, tenantId)
+> SSOInitiateResponse initiateSso(provider, inviteId, tenantId)
 
 Initiate Sso Handler
 
@@ -410,6 +410,8 @@ async function example() {
   const body = {
     // IdpType | Provider to initiate SSO with
     provider: ...,
+    // string | Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state. (optional)
+    inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string | Tenant ID to initiate SSO with (optional)
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies InitiateSsoRequest;
@@ -432,6 +434,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **provider** | `IdpType` | Provider to initiate SSO with | [Defaults to `undefined`] [Enum: PASSWORD, GOOGLE, MICROSOFT, GITHUB, TENANT] |
+| **inviteId** | `string` | Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state. | [Optional] [Defaults to `undefined`] |
 | **tenantId** | `string` | Tenant ID to initiate SSO with | [Optional] [Defaults to `undefined`] |
 
 ### Return type
@@ -460,7 +463,7 @@ No authorization required
 
 ## oauth2Callback
 
-> UserResponse oauth2Callback(provider, code, state, error, errorDescription, tenantId)
+> SignUpResponse oauth2Callback(provider, code, state, error, errorDescription, tenantId)
 
 Oauth2 Callback Handler
 
@@ -520,7 +523,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**UserResponse**](UserResponse.md)
+[**SignUpResponse**](SignUpResponse.md)
 
 ### Authorization
 

package/docs/CreatePasswordUserRequest.md

@@ -10,6 +10,7 @@ Name | Type
 `emailToken` | string
 `firstName` | string
 `lastName` | string
+`inviteId` | string
 
 ## Example
 
@@ -22,6 +23,7 @@ const example = {
   "emailToken": null,
   "firstName": null,
   "lastName": null,
+  "inviteId": null,
 } satisfies CreatePasswordUserRequest
 
 console.log(example)

package/docs/FeaturesResponse.md

@@ -12,6 +12,7 @@ Name | Type
 `smsLoginEnabled` | boolean
 `defaultFrontendLanguage` | [SupportedLanguage](SupportedLanguage.md)
 `upload` | [UploadConstraints](UploadConstraints.md)
+`dataSourceEngines` | [Array<DataSourceEngine>](DataSourceEngine.md)
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "smsLoginEnabled": null,
   "defaultFrontendLanguage": null,
   "upload": null,
+  "dataSourceEngines": null,
 } satisfies FeaturesResponse
 
 console.log(example)

package/docs/FeedbackApi.md

@@ -87,11 +87,11 @@ example().catch(console.error);
 
 ## listFeedback
 
-> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
+> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, mine, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
 
 List Feedback Handler
 
-List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
 
 ### Example
 
@@ -115,10 +115,12 @@ async function example() {
   const body = {
     // FeedbackTargetType (optional)
     targetType: ...,
-    // string (optional)
-    targetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Array<string> | Repeatable. Feedback on any of these targets, so a thread page reads every visible message\'s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread). (optional)
+    targetId: ...,
     // FeedbackRating (optional)
     rating: ...,
+    // boolean | Only the caller\'s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message. (optional)
+    mine: true,
     // FeedbackOrder | Field to sort feedback by (default: CREATED_AT) (optional)
     sortBy: ...,
     // SortDirection | Sort direction; overrides the field\'s natural default (optional)
@@ -155,8 +157,9 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **targetType** | `FeedbackTargetType` |  | [Optional] [Defaults to `undefined`] [Enum: THREAD, MESSAGE, DOCUMENT, DOCUMENT_VERSION, CHUNK] |
-| **targetId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **targetId** | `Array<string>` | Repeatable. Feedback on any of these targets, so a thread page reads every visible message\&#39;s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread). | [Optional] |
 | **rating** | `FeedbackRating` |  | [Optional] [Defaults to `undefined`] [Enum: UP, DOWN] |
+| **mine** | `boolean` | Only the caller\&#39;s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message. | [Optional] [Defaults to `false`] |
 | **sortBy** | `FeedbackOrder` | Field to sort feedback by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT] |
 | **sortDir** | `SortDirection` | Sort direction; overrides the field\&#39;s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |

package/docs/GuideModuleProgress.md

@@ -0,0 +1,40 @@
+
+# GuideModuleProgress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [GuideModuleStatus](GuideModuleStatus.md)
+`step` | number
+`version` | number
+`completedAt` | Date
+
+## Example
+
+```typescript
+import type { GuideModuleProgress } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "step": null,
+  "version": null,
+  "completedAt": null,
+} satisfies GuideModuleProgress
+
+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 GuideModuleProgress
+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/GuideModuleStatus.md

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

@@ -0,0 +1,60 @@
+
+# GuideModules
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`core` | [GuideModuleProgress](GuideModuleProgress.md)
+`groundedAnswers` | [GuideModuleProgress](GuideModuleProgress.md)
+`knowledge` | [GuideModuleProgress](GuideModuleProgress.md)
+`repeatableWork` | [GuideModuleProgress](GuideModuleProgress.md)
+`access` | [GuideModuleProgress](GuideModuleProgress.md)
+`administration` | [GuideModuleProgress](GuideModuleProgress.md)
+`documents` | [GuideModuleProgress](GuideModuleProgress.md)
+`workflowRuns` | [GuideModuleProgress](GuideModuleProgress.md)
+`search` | [GuideModuleProgress](GuideModuleProgress.md)
+`workflowSetup` | [GuideModuleProgress](GuideModuleProgress.md)
+`skills` | [GuideModuleProgress](GuideModuleProgress.md)
+`dashboard` | [GuideModuleProgress](GuideModuleProgress.md)
+`groups` | [GuideModuleProgress](GuideModuleProgress.md)
+`auditLog` | [GuideModuleProgress](GuideModuleProgress.md)
+
+## Example
+
+```typescript
+import type { GuideModules } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "core": null,
+  "groundedAnswers": null,
+  "knowledge": null,
+  "repeatableWork": null,
+  "access": null,
+  "administration": null,
+  "documents": null,
+  "workflowRuns": null,
+  "search": null,
+  "workflowSetup": null,
+  "skills": null,
+  "dashboard": null,
+  "groups": null,
+  "auditLog": null,
+} satisfies GuideModules
+
+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 GuideModules
+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/InvitePreviewResponse.md

@@ -0,0 +1,44 @@
+
+# InvitePreviewResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | [InvitePreviewState](InvitePreviewState.md)
+`email` | string
+`tenantName` | string
+`role` | [TenantUserRole](TenantUserRole.md)
+`expiresAt` | Date
+`invitedBy` | [UserInfo](UserInfo.md)
+
+## Example
+
+```typescript
+import type { InvitePreviewResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "email": null,
+  "tenantName": null,
+  "role": null,
+  "expiresAt": null,
+  "invitedBy": null,
+} satisfies InvitePreviewResponse
+
+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 InvitePreviewResponse
+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)
+
+