@knowledge-stack/ksapi 3.11.0 → 3.13.0

package/src/models/KbSummaryResponse.ts

@@ -45,6 +45,12 @@ export interface KbSummaryResponse {
      * @memberof KbSummaryResponse
      */
     documentsByType: { [key: string]: number; };
+    /**
+     * Live document count keyed by the active version's pipeline status (pending, processing, completed, failed, cancelled, quota_limit). Documents whose active version was never ingested are absent.
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    documentsByIngestionStatus: { [key: string]: number; };
     /**
      * 
      * @type {number}
@@ -155,6 +161,7 @@ export function instanceOfKbSummaryResponse(value: object): value is KbSummaryRe
     if (!('documentsTotal' in value) || value['documentsTotal'] === undefined) return false;
     if (!('documentsByOrigin' in value) || value['documentsByOrigin'] === undefined) return false;
     if (!('documentsByType' in value) || value['documentsByType'] === undefined) return false;
+    if (!('documentsByIngestionStatus' in value) || value['documentsByIngestionStatus'] === undefined) return false;
     if (!('documentVersionsTotal' in value) || value['documentVersionsTotal'] === undefined) return false;
     if (!('chunksTotal' in value) || value['chunksTotal'] === undefined) return false;
     if (!('chunksByType' in value) || value['chunksByType'] === undefined) return false;
@@ -185,6 +192,7 @@ export function KbSummaryResponseFromJSONTyped(json: any, ignoreDiscriminator: b
         'documentsTotal': json['documents_total'],
         'documentsByOrigin': json['documents_by_origin'],
         'documentsByType': json['documents_by_type'],
+        'documentsByIngestionStatus': json['documents_by_ingestion_status'],
         'documentVersionsTotal': json['document_versions_total'],
         'chunksTotal': json['chunks_total'],
         'chunksByType': json['chunks_by_type'],
@@ -216,6 +224,7 @@ export function KbSummaryResponseToJSONTyped(value?: KbSummaryResponse | null, i
         'documents_total': value['documentsTotal'],
         'documents_by_origin': value['documentsByOrigin'],
         'documents_by_type': value['documentsByType'],
+        'documents_by_ingestion_status': value['documentsByIngestionStatus'],
         'document_versions_total': value['documentVersionsTotal'],
         'chunks_total': value['chunksTotal'],
         'chunks_by_type': value['chunksByType'],

package/src/models/{OnboardingProfileRequest.ts → OnboardingState.ts}

@@ -13,32 +13,49 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GuideModules } from './GuideModules';
+import {
+    GuideModulesFromJSON,
+    GuideModulesFromJSONTyped,
+    GuideModulesToJSON,
+    GuideModulesToJSONTyped,
+} from './GuideModules';
+import type { OnboardingStep } from './OnboardingStep';
+import {
+    OnboardingStepFromJSON,
+    OnboardingStepFromJSONTyped,
+    OnboardingStepToJSON,
+    OnboardingStepToJSONTyped,
+} from './OnboardingStep';
+
 /**
- * Step 2 of onboarding — per-user info for the current tenant.
+ * Stored state: keys and steps this release does not know are dropped.
  * @export
- * @interface OnboardingProfileRequest
+ * @interface OnboardingState
  */
-export interface OnboardingProfileRequest {
+export interface OnboardingState {
     /**
-     * User's first name
-     * @type {string}
-     * @memberof OnboardingProfileRequest
+     * 
+     * @type {OnboardingStep}
+     * @memberof OnboardingState
      */
-    firstName?: string | null;
+    currentStep?: OnboardingStep;
     /**
-     * User's last name
-     * @type {string}
-     * @memberof OnboardingProfileRequest
+     * 
+     * @type {GuideModules}
+     * @memberof OnboardingState
      */
-    lastName?: string | null;
+    guideModules?: GuideModules;
     /**
-     * What the user does at this tenant
-     * @type {string}
-     * @memberof OnboardingProfileRequest
+     * 
+     * @type {boolean}
+     * @memberof OnboardingState
      */
-    jobTitle?: string | null;
+    setupChecklistDismissed?: boolean;
 }
-export const OnboardingProfileRequestPropertyValidationAttributesMap: {
+
+
+export const OnboardingStatePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,
@@ -53,49 +70,46 @@ export const OnboardingProfileRequestPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
-    jobTitle: {
-        maxLength: 120,
-    },
 }
 
 
 /**
- * Check if a given object implements the OnboardingProfileRequest interface.
+ * Check if a given object implements the OnboardingState interface.
  */
-export function instanceOfOnboardingProfileRequest(value: object): value is OnboardingProfileRequest {
+export function instanceOfOnboardingState(value: object): value is OnboardingState {
     return true;
 }
 
-export function OnboardingProfileRequestFromJSON(json: any): OnboardingProfileRequest {
-    return OnboardingProfileRequestFromJSONTyped(json, false);
+export function OnboardingStateFromJSON(json: any): OnboardingState {
+    return OnboardingStateFromJSONTyped(json, false);
 }
 
-export function OnboardingProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingProfileRequest {
+export function OnboardingStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingState {
     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'],
+        'currentStep': json['current_step'] == null ? undefined : OnboardingStepFromJSON(json['current_step']),
+        'guideModules': json['guide_modules'] == null ? undefined : GuideModulesFromJSON(json['guide_modules']),
+        'setupChecklistDismissed': json['setup_checklist_dismissed'] == null ? undefined : json['setup_checklist_dismissed'],
     };
 }
 
-export function OnboardingProfileRequestToJSON(json: any): OnboardingProfileRequest {
-    return OnboardingProfileRequestToJSONTyped(json, false);
+export function OnboardingStateToJSON(json: any): OnboardingState {
+    return OnboardingStateToJSONTyped(json, false);
 }
 
-export function OnboardingProfileRequestToJSONTyped(value?: OnboardingProfileRequest | null, ignoreDiscriminator: boolean = false): any {
+export function OnboardingStateToJSONTyped(value?: OnboardingState | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
-        'first_name': value['firstName'],
-        'last_name': value['lastName'],
-        'job_title': value['jobTitle'],
+        'current_step': OnboardingStepToJSON(value['currentStep']),
+        'guide_modules': GuideModulesToJSON(value['guideModules']),
+        'setup_checklist_dismissed': value['setupChecklistDismissed'],
     };
 }
 

package/src/models/OnboardingStateUpdate.ts

@@ -0,0 +1,115 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { GuideModules } from './GuideModules';
+import {
+    GuideModulesFromJSON,
+    GuideModulesFromJSONTyped,
+    GuideModulesToJSON,
+    GuideModulesToJSONTyped,
+} from './GuideModules';
+import type { OnboardingStep } from './OnboardingStep';
+import {
+    OnboardingStepFromJSON,
+    OnboardingStepFromJSONTyped,
+    OnboardingStepToJSON,
+    OnboardingStepToJSONTyped,
+} from './OnboardingStep';
+
+/**
+ * 
+ * @export
+ * @interface OnboardingStateUpdate
+ */
+export interface OnboardingStateUpdate {
+    /**
+     * 
+     * @type {OnboardingStep}
+     * @memberof OnboardingStateUpdate
+     */
+    currentStep?: OnboardingStep;
+    /**
+     * Guide module progress to merge in. A completed or dismissed module only moves back to in progress under a newer module version.
+     * @type {GuideModules}
+     * @memberof OnboardingStateUpdate
+     */
+    guideModules?: GuideModules | null;
+    /**
+     * Whether the setup checklist is dismissed
+     * @type {boolean}
+     * @memberof OnboardingStateUpdate
+     */
+    setupChecklistDismissed?: boolean | null;
+}
+
+
+export const OnboardingStateUpdatePropertyValidationAttributesMap: {
+    [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 OnboardingStateUpdate interface.
+ */
+export function instanceOfOnboardingStateUpdate(value: object): value is OnboardingStateUpdate {
+    return true;
+}
+
+export function OnboardingStateUpdateFromJSON(json: any): OnboardingStateUpdate {
+    return OnboardingStateUpdateFromJSONTyped(json, false);
+}
+
+export function OnboardingStateUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingStateUpdate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'currentStep': json['current_step'] == null ? undefined : OnboardingStepFromJSON(json['current_step']),
+        'guideModules': json['guide_modules'] == null ? undefined : GuideModulesFromJSON(json['guide_modules']),
+        'setupChecklistDismissed': json['setup_checklist_dismissed'] == null ? undefined : json['setup_checklist_dismissed'],
+    };
+}
+
+export function OnboardingStateUpdateToJSON(json: any): OnboardingStateUpdate {
+    return OnboardingStateUpdateToJSONTyped(json, false);
+}
+
+export function OnboardingStateUpdateToJSONTyped(value?: OnboardingStateUpdate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'current_step': OnboardingStepToJSON(value['currentStep']),
+        'guide_modules': GuideModulesToJSON(value['guideModules']),
+        'setup_checklist_dismissed': value['setupChecklistDismissed'],
+    };
+}
+

package/src/models/OnboardingStep.ts

@@ -0,0 +1,55 @@
+/* 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 OnboardingStep = {
+    Workspace: 'WORKSPACE',
+    Knowledge: 'KNOWLEDGE',
+    Team: 'TEAM',
+    Destination: 'DESTINATION'
+} as const;
+export type OnboardingStep = typeof OnboardingStep[keyof typeof OnboardingStep];
+
+
+export function instanceOfOnboardingStep(value: any): boolean {
+    for (const key in OnboardingStep) {
+        if (Object.prototype.hasOwnProperty.call(OnboardingStep, key)) {
+            if (OnboardingStep[key as keyof typeof OnboardingStep] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function OnboardingStepFromJSON(json: any): OnboardingStep {
+    return OnboardingStepFromJSONTyped(json, false);
+}
+
+export function OnboardingStepFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingStep {
+    return json as OnboardingStep;
+}
+
+export function OnboardingStepToJSON(value?: OnboardingStep | null): any {
+    return value as any;
+}
+
+export function OnboardingStepToJSONTyped(value: any, ignoreDiscriminator: boolean): OnboardingStep {
+    return value as OnboardingStep;
+}
+

package/src/models/SignUpResponse.ts

@@ -0,0 +1,303 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { TenantUserJoinMethod } from './TenantUserJoinMethod';
+import {
+    TenantUserJoinMethodFromJSON,
+    TenantUserJoinMethodFromJSONTyped,
+    TenantUserJoinMethodToJSON,
+    TenantUserJoinMethodToJSONTyped,
+} from './TenantUserJoinMethod';
+import type { IdpType } from './IdpType';
+import {
+    IdpTypeFromJSON,
+    IdpTypeFromJSONTyped,
+    IdpTypeToJSON,
+    IdpTypeToJSONTyped,
+} from './IdpType';
+import type { InviteRejection } from './InviteRejection';
+import {
+    InviteRejectionFromJSON,
+    InviteRejectionFromJSONTyped,
+    InviteRejectionToJSON,
+    InviteRejectionToJSONTyped,
+} from './InviteRejection';
+import type { TenantUserRole } from './TenantUserRole';
+import {
+    TenantUserRoleFromJSON,
+    TenantUserRoleFromJSONTyped,
+    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';
+
+/**
+ * 
+ * @export
+ * @interface SignUpResponse
+ */
+export interface SignUpResponse {
+    /**
+     * User ID
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    id: string;
+    /**
+     * Email address of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    email: string | null;
+    /**
+     * Subscriber number as a string of digits (no country code). Returned as a string to avoid JS Number precision issues.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    phoneNumber?: string | null;
+    /**
+     * First name of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    firstName: string | null;
+    /**
+     * Last name of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    lastName: string | null;
+    /**
+     * 
+     * @type {IdpType}
+     * @memberof SignUpResponse
+     */
+    idpType: IdpType;
+    /**
+     * Current tenant ID the user is logged into
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    currentTenantId: string;
+    /**
+     * 
+     * @type {TenantUserRole}
+     * @memberof SignUpResponse
+     */
+    currentTenantRole: TenantUserRole;
+    /**
+     * Default tenant ID the user shall be logged into
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    defaultTenantId: string;
+    /**
+     * User's job title at the current tenant (per-membership)
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    jobTitle?: string | null;
+    /**
+     * User's department at the current tenant (per-membership)
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    department?: string | null;
+    /**
+     * What the user wrote about themselves at the current tenant. The chat agent reads it on every turn.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    bio?: string | null;
+    /**
+     * Presigned URL of the user's profile photo at the current tenant. Expires after six hours; read GET /v1/users/me again for a fresh one.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    avatarUrl?: string | null;
+    /**
+     * When the user finished onboarding for the current tenant. NULL = wizard should be shown.
+     * @type {Date}
+     * @memberof SignUpResponse
+     */
+    onboardingCompletedAt?: Date | null;
+    /**
+     * 
+     * @type {TenantUserJoinMethod}
+     * @memberof SignUpResponse
+     */
+    joinMethod: TenantUserJoinMethod;
+    /**
+     * Resume step and guide progress for the current membership.
+     * @type {OnboardingState}
+     * @memberof SignUpResponse
+     */
+    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 SignUpResponse
+     */
+    invitedBy?: UserInfo | null;
+    /**
+     * 
+     * @type {AddedBy}
+     * @memberof SignUpResponse
+     */
+    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 SignUpResponse
+     */
+    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 SignUpResponse
+     */
+    onboardingEnabled?: boolean | null;
+    /**
+     * 
+     * @type {InviteRejection}
+     * @memberof SignUpResponse
+     */
+    inviteRejection?: InviteRejection;
+}
+
+
+export const SignUpResponsePropertyValidationAttributesMap: {
+    [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 SignUpResponse interface.
+ */
+export function instanceOfSignUpResponse(value: object): value is SignUpResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('idpType' in value) || value['idpType'] === undefined) return false;
+    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;
+}
+
+export function SignUpResponseFromJSON(json: any): SignUpResponse {
+    return SignUpResponseFromJSONTyped(json, false);
+}
+
+export function SignUpResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignUpResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'email': json['email'],
+        'phoneNumber': json['phone_number'] == null ? undefined : json['phone_number'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'idpType': IdpTypeFromJSON(json['idp_type']),
+        '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'],
+        'department': json['department'] == null ? undefined : json['department'],
+        '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'],
+        'inviteRejection': json['invite_rejection'] == null ? undefined : InviteRejectionFromJSON(json['invite_rejection']),
+    };
+}
+
+export function SignUpResponseToJSON(json: any): SignUpResponse {
+    return SignUpResponseToJSONTyped(json, false);
+}
+
+export function SignUpResponseToJSONTyped(value?: SignUpResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'email': value['email'],
+        'phone_number': value['phoneNumber'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'idp_type': IdpTypeToJSON(value['idpType']),
+        'current_tenant_id': value['currentTenantId'],
+        'current_tenant_role': TenantUserRoleToJSON(value['currentTenantRole']),
+        'default_tenant_id': value['defaultTenantId'],
+        'job_title': value['jobTitle'],
+        'department': value['department'],
+        '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'],
+        'invite_rejection': InviteRejectionToJSON(value['inviteRejection']),
+    };
+}
+