@knowledge-stack/ksapi 1.80.1 → 1.81.0

package/dist/models/OnboardingProfileRequest.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.OnboardingProfileRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfOnboardingProfileRequest = instanceOfOnboardingProfileRequest;
+exports.OnboardingProfileRequestFromJSON = OnboardingProfileRequestFromJSON;
+exports.OnboardingProfileRequestFromJSONTyped = OnboardingProfileRequestFromJSONTyped;
+exports.OnboardingProfileRequestToJSON = OnboardingProfileRequestToJSON;
+exports.OnboardingProfileRequestToJSONTyped = OnboardingProfileRequestToJSONTyped;
+exports.OnboardingProfileRequestPropertyValidationAttributesMap = {
+    jobTitle: {
+        maxLength: 120,
+    },
+};
+/**
+ * Check if a given object implements the OnboardingProfileRequest interface.
+ */
+function instanceOfOnboardingProfileRequest(value) {
+    return true;
+}
+function OnboardingProfileRequestFromJSON(json) {
+    return OnboardingProfileRequestFromJSONTyped(json, false);
+}
+function OnboardingProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['first_name'] == null ? undefined : json['first_name'],
+        'lastName': json['last_name'] == null ? undefined : json['last_name'],
+        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+    };
+}
+function OnboardingProfileRequestToJSON(json) {
+    return OnboardingProfileRequestToJSONTyped(json, false);
+}
+function OnboardingProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'job_title': value['jobTitle'],
+    };
+}

package/dist/models/TenantSettingsResponse.d.ts

@@ -29,6 +29,12 @@ export interface TenantSettingsResponse {
      * @memberof TenantSettingsResponse
      */
     description: string;
+    /**
+     * Industry / company type captured during onboarding
+     * @type {string}
+     * @memberof TenantSettingsResponse
+     */
+    industry?: string | null;
     /**
      * IANA timezone (e.g. 'America/New_York')
      * @type {string}

package/dist/models/TenantSettingsResponse.js

@@ -46,6 +46,7 @@ function TenantSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'language': (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
         'description': json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
         'timezone': json['timezone'],
         'inviteLink': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseFromJSON)(json['invite_link']),
     };
@@ -60,6 +61,7 @@ function TenantSettingsResponseToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'invite_link': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseToJSON)(value['inviteLink']),
     };

package/dist/models/TenantSettingsUpdate.d.ts

@@ -29,6 +29,12 @@ export interface TenantSettingsUpdate {
      * @memberof TenantSettingsUpdate
      */
     description?: string | null;
+    /**
+     * Industry / company type captured during onboarding
+     * @type {string}
+     * @memberof TenantSettingsUpdate
+     */
+    industry?: string | null;
     /**
      * IANA timezone (e.g. 'America/New_York')
      * @type {string}

package/dist/models/TenantSettingsUpdate.js

@@ -21,7 +21,14 @@ exports.TenantSettingsUpdateToJSON = TenantSettingsUpdateToJSON;
 exports.TenantSettingsUpdateToJSONTyped = TenantSettingsUpdateToJSONTyped;
 const SupportedLanguage_1 = require("./SupportedLanguage");
 const InviteLinkSettingsRequest_1 = require("./InviteLinkSettingsRequest");
-exports.TenantSettingsUpdatePropertyValidationAttributesMap = {};
+exports.TenantSettingsUpdatePropertyValidationAttributesMap = {
+    description: {
+        maxLength: 5000,
+    },
+    industry: {
+        maxLength: 120,
+    },
+};
 /**
  * Check if a given object implements the TenantSettingsUpdate interface.
  */
@@ -38,6 +45,7 @@ function TenantSettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'language': json['language'] == null ? undefined : (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
         'description': json['description'] == null ? undefined : json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
         'timezone': json['timezone'] == null ? undefined : json['timezone'],
         'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
         'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
@@ -55,6 +63,7 @@ function TenantSettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'brand_name': value['brandName'],
         'brand_color': value['brandColor'],

package/dist/models/UserResponse.d.ts

@@ -65,6 +65,18 @@ export interface UserResponse {
      * @memberof UserResponse
      */
     defaultTenantId: string;
+    /**
+     * User's job title at the current tenant (per-membership)
+     * @type {string}
+     * @memberof UserResponse
+     */
+    jobTitle?: string | null;
+    /**
+     * When the user finished onboarding for the current tenant. NULL = wizard should be shown.
+     * @type {Date}
+     * @memberof UserResponse
+     */
+    onboardingCompletedAt?: Date | null;
 }
 export declare const UserResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/UserResponse.js

@@ -60,6 +60,8 @@ function UserResponseFromJSONTyped(json, ignoreDiscriminator) {
         'currentTenantId': json['current_tenant_id'],
         'currentTenantRole': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['current_tenant_role']),
         'defaultTenantId': json['default_tenant_id'],
+        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+        'onboardingCompletedAt': json['onboarding_completed_at'] == null ? undefined : (new Date(json['onboarding_completed_at'])),
     };
 }
 function UserResponseToJSON(json) {
@@ -78,5 +80,7 @@ function UserResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'current_tenant_id': value['currentTenantId'],
         'current_tenant_role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['currentTenantRole']),
         'default_tenant_id': value['defaultTenantId'],
+        'job_title': value['jobTitle'],
+        'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
     };
 }

package/dist/models/index.d.ts

@@ -88,6 +88,8 @@ export * from './MembershipResponse';
 export * from './MessageRole';
 export * from './MeteredQuotaStatus';
 export * from './NonFilesystemReferenceType';
+export * from './OnboardingCompanyRequest';
+export * from './OnboardingProfileRequest';
 export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseDocumentResponse';

package/dist/models/index.js

@@ -106,6 +106,8 @@ __exportStar(require("./MembershipResponse"), exports);
 __exportStar(require("./MessageRole"), exports);
 __exportStar(require("./MeteredQuotaStatus"), exports);
 __exportStar(require("./NonFilesystemReferenceType"), exports);
+__exportStar(require("./OnboardingCompanyRequest"), exports);
+__exportStar(require("./OnboardingProfileRequest"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseDocumentResponse"), exports);

package/docs/OnboardingCompanyRequest.md

@@ -0,0 +1,37 @@
+
+# OnboardingCompanyRequest
+
+Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`industry` | string
+
+## Example
+
+```typescript
+import type { OnboardingCompanyRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "industry": null,
+} satisfies OnboardingCompanyRequest
+
+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 OnboardingCompanyRequest
+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/OnboardingProfileRequest.md

@@ -0,0 +1,39 @@
+
+# OnboardingProfileRequest
+
+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'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "jobTitle": null,
+} satisfies OnboardingProfileRequest
+
+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 OnboardingProfileRequest
+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/TenantSettingsResponse.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `language` | [SupportedLanguage](SupportedLanguage.md)
 `description` | string
+`industry` | string
 `timezone` | string
 `inviteLink` | [InviteLinkSettingsResponse](InviteLinkSettingsResponse.md)
 
@@ -21,6 +22,7 @@ import type { TenantSettingsResponse } from '@knowledge-stack/ksapi'
 const example = {
   "language": null,
   "description": null,
+  "industry": null,
   "timezone": null,
   "inviteLink": null,
 } satisfies TenantSettingsResponse

package/docs/TenantSettingsUpdate.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `language` | [SupportedLanguage](SupportedLanguage.md)
 `description` | string
+`industry` | string
 `timezone` | string
 `brandName` | string
 `brandColor` | string
@@ -24,6 +25,7 @@ import type { TenantSettingsUpdate } from '@knowledge-stack/ksapi'
 const example = {
   "language": null,
   "description": null,
+  "industry": null,
   "timezone": null,
   "brandName": null,
   "brandColor": null,

package/docs/UserResponse.md

@@ -14,6 +14,8 @@ Name | Type
 `currentTenantId` | string
 `currentTenantRole` | [TenantUserRole](TenantUserRole.md)
 `defaultTenantId` | string
+`jobTitle` | string
+`onboardingCompletedAt` | Date
 
 ## Example
 
@@ -30,6 +32,8 @@ const example = {
   "currentTenantId": null,
   "currentTenantRole": null,
   "defaultTenantId": null,
+  "jobTitle": null,
+  "onboardingCompletedAt": null,
 } satisfies UserResponse
 
 console.log(example)

package/docs/UsersApi.md

@@ -5,7 +5,10 @@ All URIs are relative to *http://localhost:8000*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**getMe**](UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler |
+| [**skipOnboarding**](UsersApi.md#skiponboarding) | **POST** /v1/users/me/onboarding/skip | Skip Onboarding Handler |
 | [**updateMe**](UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler |
+| [**updateOnboardingCompany**](UsersApi.md#updateonboardingcompany) | **PATCH** /v1/users/me/onboarding/company | Update Onboarding Company Handler |
+| [**updateOnboardingProfile**](UsersApi.md#updateonboardingprofile) | **PATCH** /v1/users/me/onboarding/profile | Update Onboarding Profile Handler |
 
 
 
@@ -80,6 +83,77 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## skipOnboarding
+
+> UserResponse skipOnboarding(authorization, ksUat)
+
+Skip Onboarding Handler
+
+Mark onboarding complete without writing any profile/company fields.  Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '@knowledge-stack/ksapi';
+import type { SkipOnboardingRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies SkipOnboardingRequest;
+
+  try {
+    const data = await api.skipOnboarding(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+
 ## updateMe
 
 > UserResponse updateMe(updateUserRequest, authorization, ksUat)
@@ -153,3 +227,151 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## updateOnboardingCompany
+
+> UserResponse updateOnboardingCompany(onboardingCompanyRequest, authorization, ksUat)
+
+Update Onboarding Company Handler
+
+Step 1 of onboarding: tenant-wide company info.  Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead.  Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateOnboardingCompanyRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // OnboardingCompanyRequest
+    onboardingCompanyRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateOnboardingCompanyRequest;
+
+  try {
+    const data = await api.updateOnboardingCompany(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **onboardingCompanyRequest** | [OnboardingCompanyRequest](OnboardingCompanyRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## updateOnboardingProfile
+
+> UserResponse updateOnboardingProfile(onboardingProfileRequest, authorization, ksUat)
+
+Update Onboarding Profile Handler
+
+Step 2 (final) of onboarding: per-user profile for the current tenant.  Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsersApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateOnboardingProfileRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new UsersApi();
+
+  const body = {
+    // OnboardingProfileRequest
+    onboardingProfileRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateOnboardingProfileRequest;
+
+  try {
+    const data = await api.updateOnboardingProfile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **onboardingProfileRequest** | [OnboardingProfileRequest](OnboardingProfileRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.80.1",
+  "version": "1.81.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {