@knowledge-stack/ksapi 1.80.0 → 1.81.0

package/src/models/SubmitSubscriptionResponse.ts

@@ -0,0 +1,117 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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 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 function instanceOfSubmitSubscriptionResponse(value: object): value is SubmitSubscriptionResponse {
+    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;
+}
+
+export function SubmitSubscriptionResponseFromJSON(json: any): SubmitSubscriptionResponse {
+    return SubmitSubscriptionResponseFromJSONTyped(json, false);
+}
+
+export function SubmitSubscriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitSubscriptionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'submitted': json['submitted'],
+        'noop': json['noop'],
+        'idempotencyKey': json['idempotency_key'],
+    };
+}
+
+export function SubmitSubscriptionResponseToJSON(json: any): SubmitSubscriptionResponse {
+    return SubmitSubscriptionResponseToJSONTyped(json, false);
+}
+
+export function SubmitSubscriptionResponseToJSONTyped(value?: SubmitSubscriptionResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'submitted': value['submitted'],
+        'noop': value['noop'],
+        'idempotency_key': value['idempotencyKey'],
+    };
+}
+

package/src/models/TenantSettingsResponse.ts

@@ -46,6 +46,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}
@@ -102,6 +108,7 @@ export function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminat
         
         'language': SupportedLanguageFromJSON(json['language']),
         'description': json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
         'timezone': json['timezone'],
         'inviteLink': InviteLinkSettingsResponseFromJSON(json['invite_link']),
     };
@@ -120,6 +127,7 @@ export function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse
         
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'invite_link': InviteLinkSettingsResponseToJSON(value['inviteLink']),
     };

package/src/models/TenantSettingsUpdate.ts

@@ -46,6 +46,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}
@@ -94,6 +100,12 @@ export const TenantSettingsUpdatePropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    description: {
+        maxLength: 5000,
+    },
+    industry: {
+        maxLength: 120,
+    },
 }
 
 
@@ -116,6 +128,7 @@ export function TenantSettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator
         
         'language': json['language'] == null ? undefined : 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'],
@@ -137,6 +150,7 @@ export function TenantSettingsUpdateToJSONTyped(value?: TenantSettingsUpdate | n
         
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'brand_name': value['brandName'],
         'brand_color': value['brandColor'],

package/src/models/UserResponse.ts

@@ -82,6 +82,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;
 }
 
 
@@ -136,6 +148,8 @@ export function UserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'currentTenantId': json['current_tenant_id'],
         'currentTenantRole': 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'])),
     };
 }
 
@@ -158,6 +172,8 @@ export function UserResponseToJSONTyped(value?: UserResponse | null, ignoreDiscr
         'current_tenant_id': value['currentTenantId'],
         'current_tenant_role': TenantUserRoleToJSON(value['currentTenantRole']),
         'default_tenant_id': value['defaultTenantId'],
+        'job_title': value['jobTitle'],
+        'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
     };
 }
 

package/src/models/index.ts

@@ -90,6 +90,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';
@@ -144,6 +146,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';