@knowledge-stack/ksapi 1.65.8 → 1.66.2

package/dist/esm/apis/AuthApi.d.ts

@@ -1,422 +0,0 @@
-/**
- * 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 * as runtime from '../runtime';
-import type { CreatePasswordUserRequest, EmailSentResponse, EmailVerificationRequest, IdpType, PasswordResetRequest, PasswordResetWithTokenRequest, SSOInitiateResponse, SignInRequest, UserResponse } from '../models/index';
-export interface CreatePasswordUserOperationRequest {
-    createPasswordUserRequest: CreatePasswordUserRequest;
-}
-export interface InitiateSsoRequest {
-    provider: IdpType;
-    tenantId?: string | null;
-}
-export interface Oauth2CallbackRequest {
-    provider: IdpType;
-    code?: string | null;
-    state?: string | null;
-    error?: string | null;
-    errorDescription?: string | null;
-    tenantId?: string | null;
-}
-export interface PwEmailVerificationRequest {
-    emailVerificationRequest: EmailVerificationRequest;
-}
-export interface PwSigninRequest {
-    signInRequest: SignInRequest;
-}
-export interface RefreshUatRequest {
-    tenantId?: string | null;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface ResetPasswordRequest {
-    passwordResetRequest: PasswordResetRequest;
-    authorization?: string | null;
-    ksUat?: string | null;
-}
-export interface ResetPasswordWithTokenRequest {
-    passwordResetWithTokenRequest: PasswordResetWithTokenRequest;
-}
-export interface SendPwResetEmailRequest {
-    emailVerificationRequest: EmailVerificationRequest;
-}
-/**
- * AuthApi - interface
- *
- * @export
- * @interface AuthApiInterface
- */
-export interface AuthApiInterface {
-    /**
-     * Creates request options for createPasswordUser without sending the request
-     * @param {CreatePasswordUserRequest} createPasswordUserRequest
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    createPasswordUserRequestOpts(requestParameters: CreatePasswordUserOperationRequest): Promise<runtime.RequestOpts>;
-    /**
-     *
-     * @summary Create Password User Handler
-     * @param {CreatePasswordUserRequest} createPasswordUserRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Create Password User Handler
-     */
-    createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for initiateSso without sending the request
-     * @param {IdpType} provider Provider to initiate SSO with
-     * @param {string} [tenantId] Tenant ID to initiate SSO with
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    initiateSsoRequestOpts(requestParameters: InitiateSsoRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Initiate SSO with the given provider and tenant ID.
-     * @summary Initiate Sso Handler
-     * @param {IdpType} provider Provider to initiate SSO with
-     * @param {string} [tenantId] Tenant ID to initiate SSO with
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    initiateSsoRaw(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SSOInitiateResponse>>;
-    /**
-     * Initiate SSO with the given provider and tenant ID.
-     * Initiate Sso Handler
-     */
-    initiateSso(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SSOInitiateResponse>;
-    /**
-     * Creates request options for oauth2Callback without sending the request
-     * @param {IdpType} provider Provider to initiate SSO with
-     * @param {string} [code] Authorization code from provider
-     * @param {string} [state] State parameter for CSRF protection
-     * @param {string} [error] Error code if authorization failed
-     * @param {string} [errorDescription] Error description
-     * @param {string} [tenantId] Tenant ID to initiate SSO with
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    oauth2CallbackRequestOpts(requestParameters: Oauth2CallbackRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Handle OAuth2 callback from the given OAuth client.
-     * @summary Oauth2 Callback Handler
-     * @param {IdpType} provider Provider to initiate SSO with
-     * @param {string} [code] Authorization code from provider
-     * @param {string} [state] State parameter for CSRF protection
-     * @param {string} [error] Error code if authorization failed
-     * @param {string} [errorDescription] Error description
-     * @param {string} [tenantId] Tenant ID to initiate SSO with
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Handle OAuth2 callback from the given OAuth client.
-     * Oauth2 Callback Handler
-     */
-    oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for pwEmailVerification without sending the request
-     * @param {EmailVerificationRequest} emailVerificationRequest
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    pwEmailVerificationRequestOpts(requestParameters: PwEmailVerificationRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Send password user email verification email.  This endpoint is the first step in the password user creation process. The user receives an email with a link to create their account.
-     * @summary Pw Email Verification Handler
-     * @param {EmailVerificationRequest} emailVerificationRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    pwEmailVerificationRaw(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
-    /**
-     * Send password user email verification email.  This endpoint is the first step in the password user creation process. The user receives an email with a link to create their account.
-     * Pw Email Verification Handler
-     */
-    pwEmailVerification(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
-    /**
-     * Creates request options for pwSignin without sending the request
-     * @param {SignInRequest} signInRequest
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    pwSigninRequestOpts(requestParameters: PwSigninRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Validate password credentials and redirect to callback.  This endpoint validates the user\'s credentials and stores the user ID in the session, then redirects to /auth/callback?method=pw to maintain consistency with OAuth flows.
-     * @summary Signin Handler
-     * @param {SignInRequest} signInRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    pwSigninRaw(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Validate password credentials and redirect to callback.  This endpoint validates the user\'s credentials and stores the user ID in the session, then redirects to /auth/callback?method=pw to maintain consistency with OAuth flows.
-     * Signin Handler
-     */
-    pwSignin(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for refreshUat without sending the request
-     * @param {string} [tenantId] Target tenant ID to switch to. None&#x3D;refresh current tenant
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    refreshUatRequestOpts(requestParameters: RefreshUatRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Refresh or switch the user\'s active tenant token.
-     * @summary Refresh Uat Handler
-     * @param {string} [tenantId] Target tenant ID to switch to. None&#x3D;refresh current tenant
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    refreshUatRaw(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Refresh or switch the user\'s active tenant token.
-     * Refresh Uat Handler
-     */
-    refreshUat(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for resetPassword without sending the request
-     * @param {PasswordResetRequest} passwordResetRequest
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Reset password for the authenticated user
-     * @summary Reset Password Handler
-     * @param {PasswordResetRequest} passwordResetRequest
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Reset password for the authenticated user
-     * Reset Password Handler
-     */
-    resetPassword(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for resetPasswordWithToken without sending the request
-     * @param {PasswordResetWithTokenRequest} passwordResetWithTokenRequest
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Reset password with email verification token
-     * @summary Reset Password With Token Handler
-     * @param {PasswordResetWithTokenRequest} passwordResetWithTokenRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Reset password with email verification token
-     * Reset Password With Token Handler
-     */
-    resetPasswordWithToken(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for sendPwResetEmail without sending the request
-     * @param {EmailVerificationRequest} emailVerificationRequest
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts>;
-    /**
-     *
-     * @summary Send Pw Reset Email Handler
-     * @param {EmailVerificationRequest} emailVerificationRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
-    /**
-     * Send Pw Reset Email Handler
-     */
-    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
-    /**
-     * Creates request options for signout without sending the request
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    signoutRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     *
-     * @summary Signout Handler
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AuthApiInterface
-     */
-    signoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
-    /**
-     * Signout Handler
-     */
-    signout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
-}
-/**
- *
- */
-export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
-    /**
-     * Creates request options for createPasswordUser without sending the request
-     */
-    createPasswordUserRequestOpts(requestParameters: CreatePasswordUserOperationRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Create Password User Handler
-     */
-    createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Create Password User Handler
-     */
-    createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for initiateSso without sending the request
-     */
-    initiateSsoRequestOpts(requestParameters: InitiateSsoRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Initiate SSO with the given provider and tenant ID.
-     * Initiate Sso Handler
-     */
-    initiateSsoRaw(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SSOInitiateResponse>>;
-    /**
-     * Initiate SSO with the given provider and tenant ID.
-     * Initiate Sso Handler
-     */
-    initiateSso(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SSOInitiateResponse>;
-    /**
-     * Creates request options for oauth2Callback without sending the request
-     */
-    oauth2CallbackRequestOpts(requestParameters: Oauth2CallbackRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Handle OAuth2 callback from the given OAuth client.
-     * Oauth2 Callback Handler
-     */
-    oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Handle OAuth2 callback from the given OAuth client.
-     * Oauth2 Callback Handler
-     */
-    oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for pwEmailVerification without sending the request
-     */
-    pwEmailVerificationRequestOpts(requestParameters: PwEmailVerificationRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Send password user email verification email.  This endpoint is the first step in the password user creation process. The user receives an email with a link to create their account.
-     * Pw Email Verification Handler
-     */
-    pwEmailVerificationRaw(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
-    /**
-     * Send password user email verification email.  This endpoint is the first step in the password user creation process. The user receives an email with a link to create their account.
-     * Pw Email Verification Handler
-     */
-    pwEmailVerification(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
-    /**
-     * Creates request options for pwSignin without sending the request
-     */
-    pwSigninRequestOpts(requestParameters: PwSigninRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Validate password credentials and redirect to callback.  This endpoint validates the user\'s credentials and stores the user ID in the session, then redirects to /auth/callback?method=pw to maintain consistency with OAuth flows.
-     * Signin Handler
-     */
-    pwSigninRaw(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Validate password credentials and redirect to callback.  This endpoint validates the user\'s credentials and stores the user ID in the session, then redirects to /auth/callback?method=pw to maintain consistency with OAuth flows.
-     * Signin Handler
-     */
-    pwSignin(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for refreshUat without sending the request
-     */
-    refreshUatRequestOpts(requestParameters: RefreshUatRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Refresh or switch the user\'s active tenant token.
-     * Refresh Uat Handler
-     */
-    refreshUatRaw(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Refresh or switch the user\'s active tenant token.
-     * Refresh Uat Handler
-     */
-    refreshUat(requestParameters?: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for resetPassword without sending the request
-     */
-    resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Reset password for the authenticated user
-     * Reset Password Handler
-     */
-    resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Reset password for the authenticated user
-     * Reset Password Handler
-     */
-    resetPassword(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for resetPasswordWithToken without sending the request
-     */
-    resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Reset password with email verification token
-     * Reset Password With Token Handler
-     */
-    resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-    /**
-     * Reset password with email verification token
-     * Reset Password With Token Handler
-     */
-    resetPasswordWithToken(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-    /**
-     * Creates request options for sendPwResetEmail without sending the request
-     */
-    sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Send Pw Reset Email Handler
-     */
-    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
-    /**
-     * Send Pw Reset Email Handler
-     */
-    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
-    /**
-     * Creates request options for signout without sending the request
-     */
-    signoutRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     * Signout Handler
-     */
-    signoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
-    /**
-     * Signout Handler
-     */
-    signout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
-}