@knowledge-stack/ksapi 3.10.2 → 3.12.0

package/src/models/TenantResponse.ts

@@ -20,6 +20,13 @@ import {
     TenantBrandingResponseToJSON,
     TenantBrandingResponseToJSONTyped,
 } from './TenantBrandingResponse';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
 import type { TenantSettingsResponse } from './TenantSettingsResponse';
 import {
     TenantSettingsResponseFromJSON,
@@ -46,6 +53,12 @@ export interface TenantResponse {
      * @memberof TenantResponse
      */
     name: string;
+    /**
+     * The tenant OWNER's name, so a member knows who can grant access. Null only when the tenant has no OWNER membership.
+     * @type {UserInfo}
+     * @memberof TenantResponse
+     */
+    owner: UserInfo | null;
     /**
      * External IdP configuration
      * @type {{ [key: string]: any; }}
@@ -105,6 +118,7 @@ export const TenantResponsePropertyValidationAttributesMap: {
 export function instanceOfTenantResponse(value: object): value is TenantResponse {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('owner' in value) || value['owner'] === undefined) return false;
     if (!('settings' in value) || value['settings'] === undefined) return false;
     if (!('seats' in value) || value['seats'] === undefined) return false;
     if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
@@ -123,6 +137,7 @@ export function TenantResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         
         'id': json['id'],
         'name': json['name'],
+        'owner': UserInfoFromJSON(json['owner']),
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
         'settings': TenantSettingsResponseFromJSON(json['settings']),
         'branding': json['branding'] == null ? undefined : TenantBrandingResponseFromJSON(json['branding']),
@@ -144,6 +159,7 @@ export function TenantResponseToJSONTyped(value?: TenantResponse | null, ignoreD
         
         'id': value['id'],
         'name': value['name'],
+        'owner': UserInfoToJSON(value['owner']),
         'idp_config': value['idpConfig'],
         'settings': TenantSettingsResponseToJSON(value['settings']),
         'branding': TenantBrandingResponseToJSON(value['branding']),

package/src/models/TenantUserJoinMethod.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const TenantUserJoinMethod = {
+    Creator: 'CREATOR',
+    Invited: 'INVITED',
+    Added: 'ADDED'
+} as const;
+export type TenantUserJoinMethod = typeof TenantUserJoinMethod[keyof typeof TenantUserJoinMethod];
+
+
+export function instanceOfTenantUserJoinMethod(value: any): boolean {
+    for (const key in TenantUserJoinMethod) {
+        if (Object.prototype.hasOwnProperty.call(TenantUserJoinMethod, key)) {
+            if (TenantUserJoinMethod[key as keyof typeof TenantUserJoinMethod] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function TenantUserJoinMethodFromJSON(json: any): TenantUserJoinMethod {
+    return TenantUserJoinMethodFromJSONTyped(json, false);
+}
+
+export function TenantUserJoinMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantUserJoinMethod {
+    return json as TenantUserJoinMethod;
+}
+
+export function TenantUserJoinMethodToJSON(value?: TenantUserJoinMethod | null): any {
+    return value as any;
+}
+
+export function TenantUserJoinMethodToJSONTyped(value: any, ignoreDiscriminator: boolean): TenantUserJoinMethod {
+    return value as TenantUserJoinMethod;
+}
+

package/src/models/UserResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { TenantUserJoinMethod } from './TenantUserJoinMethod';
+import {
+    TenantUserJoinMethodFromJSON,
+    TenantUserJoinMethodFromJSONTyped,
+    TenantUserJoinMethodToJSON,
+    TenantUserJoinMethodToJSONTyped,
+} from './TenantUserJoinMethod';
 import type { IdpType } from './IdpType';
 import {
     IdpTypeFromJSON,
@@ -27,6 +34,27 @@ import {
     TenantUserRoleToJSON,
     TenantUserRoleToJSONTyped,
 } from './TenantUserRole';
+import type { OnboardingState } from './OnboardingState';
+import {
+    OnboardingStateFromJSON,
+    OnboardingStateFromJSONTyped,
+    OnboardingStateToJSON,
+    OnboardingStateToJSONTyped,
+} from './OnboardingState';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
+import type { AddedBy } from './AddedBy';
+import {
+    AddedByFromJSON,
+    AddedByFromJSONTyped,
+    AddedByToJSON,
+    AddedByToJSONTyped,
+} from './AddedBy';
 
 /**
  * 
@@ -118,6 +146,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;
 }
 
 
@@ -151,6 +215,7 @@ export function instanceOfUserResponse(value: object): value is UserResponse {
     if (!('currentTenantId' in value) || value['currentTenantId'] === undefined) return false;
     if (!('currentTenantRole' in value) || value['currentTenantRole'] === undefined) return false;
     if (!('defaultTenantId' in value) || value['defaultTenantId'] === undefined) return false;
+    if (!('joinMethod' in value) || value['joinMethod'] === undefined) return false;
     return true;
 }
 
@@ -178,6 +243,12 @@ export function UserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolea
         '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': TenantUserJoinMethodFromJSON(json['join_method']),
+        'onboardingState': json['onboarding_state'] == null ? undefined : OnboardingStateFromJSON(json['onboarding_state']),
+        'invitedBy': json['invited_by'] == null ? undefined : UserInfoFromJSON(json['invited_by']),
+        'addedBy': json['added_by'] == null ? undefined : AddedByFromJSON(json['added_by']),
+        'idpManagedFields': json['idp_managed_fields'] == null ? undefined : json['idp_managed_fields'],
+        'onboardingEnabled': json['onboarding_enabled'] == null ? undefined : json['onboarding_enabled'],
     };
 }
 
@@ -206,6 +277,12 @@ export function UserResponseToJSONTyped(value?: UserResponse | null, ignoreDiscr
         'bio': value['bio'],
         'avatar_url': value['avatarUrl'],
         'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
+        'join_method': TenantUserJoinMethodToJSON(value['joinMethod']),
+        'onboarding_state': OnboardingStateToJSON(value['onboardingState']),
+        'invited_by': UserInfoToJSON(value['invitedBy']),
+        'added_by': AddedByToJSON(value['addedBy']),
+        'idp_managed_fields': value['idpManagedFields'],
+        'onboarding_enabled': value['onboardingEnabled'],
     };
 }
 

package/src/models/index.ts

@@ -3,8 +3,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';
@@ -158,6 +160,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';
@@ -177,6 +182,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';
@@ -203,8 +211,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';
@@ -288,6 +297,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';
@@ -321,6 +331,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';