@knowledge-stack/ksapi 1.80.0 → 1.81.0

package/dist/models/OnboardingProfileRequest.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * Step 2 of onboarding — per-user info for the current tenant.
+ * @export
+ * @interface OnboardingProfileRequest
+ */
+export interface OnboardingProfileRequest {
+    /**
+     * User's first name
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    firstName?: string | null;
+    /**
+     * User's last name
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    lastName?: string | null;
+    /**
+     * What the user does at this tenant
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    jobTitle?: string | null;
+}
+export declare const OnboardingProfileRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the OnboardingProfileRequest interface.
+ */
+export declare function instanceOfOnboardingProfileRequest(value: object): value is OnboardingProfileRequest;
+export declare function OnboardingProfileRequestFromJSON(json: any): OnboardingProfileRequest;
+export declare function OnboardingProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingProfileRequest;
+export declare function OnboardingProfileRequestToJSON(json: any): OnboardingProfileRequest;
+export declare function OnboardingProfileRequestToJSONTyped(value?: OnboardingProfileRequest | null, ignoreDiscriminator?: boolean): any;

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/SubmitSubscriptionResponse.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+/**
+ * Result envelope for the subscription-change submit endpoint.
+ *
+ * The endpoint returns immediately after the (mock-)Stripe charge is
+ * submitted; the actual plan/seat write happens later in the Stripe
+ * subscription webhook. ``submitted=True`` always when the route
+ * succeeds (errors raise via the global handler).
+ *
+ * ``noop=True`` indicates the tenant is already at the requested
+ * ``(plan, num_seats)`` — no Stripe call was issued, no webhook will
+ * arrive, and the user's account is unchanged. Symmetric with
+ * ``StripeWebhookAck.replayed`` so client UIs can render "already
+ * on this plan" rather than spinning a "waiting for webhook"
+ * indicator forever.
+ *
+ * ``idempotency_key`` echoes the value forwarded to Stripe — clients
+ * can store it to correlate the eventual webhook receipt with the
+ * original request, and re-send it verbatim on retries.
+ * @export
+ * @interface SubmitSubscriptionResponse
+ */
+export interface SubmitSubscriptionResponse {
+    /**
+     * Always True when the submit returns 202.
+     * @type {boolean}
+     * @memberof SubmitSubscriptionResponse
+     */
+    submitted: boolean;
+    /**
+     * True when the tenant was already at the target ``(plan, num_seats)`` — no Stripe call was made and no webhook will arrive.
+     * @type {boolean}
+     * @memberof SubmitSubscriptionResponse
+     */
+    noop: boolean;
+    /**
+     * Idempotency key forwarded to Stripe — sourced from the ``Idempotency-Key`` request header or a server-generated uuid4 when absent.
+     * @type {string}
+     * @memberof SubmitSubscriptionResponse
+     */
+    idempotencyKey: string;
+}
+export declare const SubmitSubscriptionResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the SubmitSubscriptionResponse interface.
+ */
+export declare function instanceOfSubmitSubscriptionResponse(value: object): value is SubmitSubscriptionResponse;
+export declare function SubmitSubscriptionResponseFromJSON(json: any): SubmitSubscriptionResponse;
+export declare function SubmitSubscriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitSubscriptionResponse;
+export declare function SubmitSubscriptionResponseToJSON(json: any): SubmitSubscriptionResponse;
+export declare function SubmitSubscriptionResponseToJSONTyped(value?: SubmitSubscriptionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SubmitSubscriptionResponse.js

@@ -0,0 +1,60 @@
+"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.SubmitSubscriptionResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfSubmitSubscriptionResponse = instanceOfSubmitSubscriptionResponse;
+exports.SubmitSubscriptionResponseFromJSON = SubmitSubscriptionResponseFromJSON;
+exports.SubmitSubscriptionResponseFromJSONTyped = SubmitSubscriptionResponseFromJSONTyped;
+exports.SubmitSubscriptionResponseToJSON = SubmitSubscriptionResponseToJSON;
+exports.SubmitSubscriptionResponseToJSONTyped = SubmitSubscriptionResponseToJSONTyped;
+exports.SubmitSubscriptionResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SubmitSubscriptionResponse interface.
+ */
+function instanceOfSubmitSubscriptionResponse(value) {
+    if (!('submitted' in value) || value['submitted'] === undefined)
+        return false;
+    if (!('noop' in value) || value['noop'] === undefined)
+        return false;
+    if (!('idempotencyKey' in value) || value['idempotencyKey'] === undefined)
+        return false;
+    return true;
+}
+function SubmitSubscriptionResponseFromJSON(json) {
+    return SubmitSubscriptionResponseFromJSONTyped(json, false);
+}
+function SubmitSubscriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'submitted': json['submitted'],
+        'noop': json['noop'],
+        'idempotencyKey': json['idempotency_key'],
+    };
+}
+function SubmitSubscriptionResponseToJSON(json) {
+    return SubmitSubscriptionResponseToJSONTyped(json, false);
+}
+function SubmitSubscriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'submitted': value['submitted'],
+        'noop': value['noop'],
+        'idempotency_key': value['idempotencyKey'],
+    };
+}

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';
@@ -142,6 +144,7 @@ export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';
 export * from './SubmitFeedbackRequest';
+export * from './SubmitSubscriptionResponse';
 export * from './SubscriptionPlanResponse';
 export * from './SubtreeChunkGroup';
 export * from './SubtreeChunksResponse';

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);
@@ -160,6 +162,7 @@ __exportStar(require("./StepInput"), exports);
 __exportStar(require("./StepKind"), exports);
 __exportStar(require("./StepOutput"), exports);
 __exportStar(require("./SubmitFeedbackRequest"), exports);
+__exportStar(require("./SubmitSubscriptionResponse"), exports);
 __exportStar(require("./SubscriptionPlanResponse"), exports);
 __exportStar(require("./SubtreeChunkGroup"), exports);
 __exportStar(require("./SubtreeChunksResponse"), exports);

package/docs/AgentApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost:8000*
 
 Agent Ask Handler
 
-Run a one-shot text agent request to completion and return the payload.  The request blocks until the underlying Temporal workflow finishes. Clients should set a generous HTTP timeout to accommodate tool-heavy runs.  Quota: consumes one MESSAGE before ``start_workflow``. Refunds on any failure between consume and ``handle.result()`` returning — pre-enqueue ``start_workflow`` raises and post-enqueue workflow failures both refund.
+Run a one-shot text agent request to completion and return the payload.  The request blocks until the underlying Temporal workflow finishes. Clients should set a generous HTTP timeout to accommodate tool-heavy runs.  Quota: consumes one MESSAGE before ``start_workflow``. Refund semantics distinguish cause:  * **Cancellation** (client disconnect → ``asyncio.CancelledError``,   OR explicit ``DELETE /v1/workflows/{id}`` while we await   ``handle.result()`` → Temporal-wrapped ``CancelledError``)   → **NO REFUND.** The user walked away or actively cancelled;   that\'s their volition. We still best-effort cancel the   workflow so the agent stops burning LLM tokens, but the   consume stays charged. Detection uses   ``temporalio.exceptions.is_cancelled_exception`` which spans   both forms. * Any other exception (pre-enqueue ``start_workflow`` raise,   Temporal failure, workflow-internal error) → **REFUND.** Server   / our-problem failures don\'t bill the user.
 
 ### Example
 

package/docs/DocumentResponse.md

@@ -24,6 +24,7 @@ Name | Type
 `createdAt` | Date
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
+`canWrite` | boolean
 
 ## Example
 
@@ -49,6 +50,7 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "tags": null,
+  "canWrite": null,
 } satisfies DocumentResponse
 
 console.log(example)

package/docs/FolderResponse.md

@@ -19,6 +19,7 @@ Name | Type
 `createdAt` | Date
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
+`canWrite` | boolean
 
 ## Example
 
@@ -39,6 +40,7 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "tags": null,
+  "canWrite": null,
 } satisfies FolderResponse
 
 console.log(example)

package/docs/FolderResponseOrDocumentResponse.md

@@ -18,6 +18,7 @@ Name | Type
 `createdAt` | Date
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
+`canWrite` | boolean
 `documentType` | [DocumentType](DocumentType.md)
 `documentOrigin` | [DocumentOrigin](DocumentOrigin.md)
 `activeVersionId` | string
@@ -43,6 +44,7 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "tags": null,
+  "canWrite": null,
   "documentType": null,
   "documentOrigin": null,
   "activeVersionId": null,

package/docs/MeteredQuotaStatus.md

@@ -12,6 +12,7 @@ Name | Type
 `limit` | number
 `periodStart` | Date
 `periodEnd` | Date
+`additionalBalance` | number
 
 ## Example
 
@@ -25,6 +26,7 @@ const example = {
   "limit": null,
   "periodStart": null,
   "periodEnd": null,
+  "additionalBalance": null,
 } satisfies MeteredQuotaStatus
 
 console.log(example)

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/SubmitSubscriptionResponse.md

@@ -0,0 +1,39 @@
+
+# SubmitSubscriptionResponse
+
+Result envelope for the subscription-change submit endpoint.  The endpoint returns immediately after the (mock-)Stripe charge is submitted; the actual plan/seat write happens later in the Stripe subscription webhook. ``submitted=True`` always when the route succeeds (errors raise via the global handler).  ``noop=True`` indicates the tenant is already at the requested ``(plan, num_seats)`` — no Stripe call was issued, no webhook will arrive, and the user\'s account is unchanged. Symmetric with ``StripeWebhookAck.replayed`` so client UIs can render \"already on this plan\" rather than spinning a \"waiting for webhook\" indicator forever.  ``idempotency_key`` echoes the value forwarded to Stripe — clients can store it to correlate the eventual webhook receipt with the original request, and re-send it verbatim on retries.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`submitted` | boolean
+`noop` | boolean
+`idempotencyKey` | string
+
+## Example
+
+```typescript
+import type { SubmitSubscriptionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "submitted": null,
+  "noop": null,
+  "idempotencyKey": null,
+} satisfies SubmitSubscriptionResponse
+
+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 SubmitSubscriptionResponse
+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/SubscriptionsApi.md

@@ -11,11 +11,11 @@ All URIs are relative to *http://localhost:8000*
 
 ## changeTenantSubscription
 
-> TenantResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey, authorization, ksUat)
+> SubmitSubscriptionResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey, authorization, ksUat)
 
 Change Tenant Subscription Handler
 
-Change the tenant\'s subscription plan and/or seat count.  OWNER-only on the target tenant. Covers three scenarios with one shape:   - Plan change (with optional seat-count change).   - Pure seat-count change (same plan, different ``num_seats``).   - No-op (same plan, same seats) — returns 200, performs no DB or     Stripe writes.  Optional ``Idempotency-Key`` request header is forwarded to Stripe verbatim (clients that retry the same logical operation MUST send the same value across attempts; Stripe collapses duplicates server- side). Absent the header, the server generates a fresh ``uuid4()`` per call and emits a warning — retries in that case are NOT deduplicated. v1 mock-Stripe doesn\'t care, but the contract is in place for the real integration.
+Submit a subscription change (mock-Stripe).  OWNER-only on the target tenant. Validates the request (tenant + plan exist, ``num_seats`` within bounds), submits the (mock-)Stripe subscription update, and returns 202. The plan/seat write is NOT applied here — that happens in ``POST /webhooks/stripe/subscription`` after Stripe confirms the change.  Async two-hop workflow per ``docs/billing_additional_limits.md`` §\"Async payment workflow\": the dev environment exercises the same submit/webhook split as production will when the real Stripe SDK replaces the log-line stub in ``notify_billing``.  Optional ``Idempotency-Key`` request header is forwarded to Stripe verbatim (clients that retry the same logical operation MUST send the same value across attempts; Stripe collapses duplicates server- side). Absent the header, the server generates a fresh ``uuid4()`` per call and emits a warning — but only when a Stripe call is actually about to fire (i.e. the validation passed AND the change is not a no-op). Warning before validation would false-positive on every 4xx and on every redundant submit.  **Header value lands in structured logs.** The header value is forwarded into the ``stripe.update_subscription`` log event\'s ``idempotency_key`` field (and into the eventual real Stripe call). Use opaque random IDs (e.g. ``uuid4()``); do NOT pass user identifiers, tokens, or other sensitive material as the ``Idempotency-Key`` header.
 
 ### Example
 
@@ -68,7 +68,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**TenantResponse**](TenantResponse.md)
+[**SubmitSubscriptionResponse**](SubmitSubscriptionResponse.md)
 
 ### Authorization
 
@@ -83,7 +83,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
+| **202** | 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/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