@knowledge-stack/ksapi 1.0.3 → 1.2.0

package/.openapi-generator/FILES

@@ -3,10 +3,39 @@
 .openapi-generator-ignore
 README.md
 package.json
+src/apis/AuthApi.ts
 src/apis/DefaultApi.ts
+src/apis/InvitesApi.ts
+src/apis/TenantsApi.ts
+src/apis/UsersApi.ts
 src/apis/index.ts
 src/index.ts
+src/models/CreatePasswordUserRequest.ts
+src/models/CreateTenantRequest.ts
+src/models/EmailSentResponse.ts
+src/models/EmailVerificationRequest.ts
+src/models/HTTPValidationError.ts
 src/models/HealthCheckResponse.ts
+src/models/IdpType.ts
+src/models/InviteResponse.ts
+src/models/InviteStatus.ts
+src/models/InviteUserRequest.ts
+src/models/OAuth2Config.ts
+src/models/PaginatedResponseInviteResponse.ts
+src/models/PaginatedResponseTenantResponse.ts
+src/models/PaginatedResponseTenantUserInTenantResponse.ts
+src/models/PasswordResetRequest.ts
+src/models/PasswordResetWithTokenRequest.ts
+src/models/RootResponse.ts
+src/models/SignInRequest.ts
+src/models/TenantResponse.ts
+src/models/TenantUserInTenantResponse.ts
+src/models/TenantUserRole.ts
+src/models/UpdateTenantRequest.ts
+src/models/UpdateUserRequest.ts
+src/models/UserResponse.ts
+src/models/ValidationError.ts
+src/models/ValidationErrorLocInner.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.esm.json

package/README.md

@@ -1,4 +1,4 @@
-## @knowledge-stack/ksapi@1.0.3
+## @knowledge-stack/ksapi@1.2.0
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @knowledge-stack/ksapi@1.0.3 --save
+npm install @knowledge-stack/ksapi@1.2.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/AuthApi.d.ts

@@ -0,0 +1,299 @@
+/**
+ * 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, SignInRequest, UserResponse } from '../models/index';
+export interface CreatePasswordUserOperationRequest {
+    createPasswordUserRequest: CreatePasswordUserRequest;
+}
+export interface InitiateSsoRequest {
+    provider: IdpType;
+    tenantId?: string;
+}
+export interface Oauth2CallbackRequest {
+    provider: IdpType;
+    code?: string;
+    state?: string;
+    error?: string;
+    errorDescription?: string;
+    tenantId?: string;
+}
+export interface PwEmailVerificationRequest {
+    emailVerificationRequest: EmailVerificationRequest;
+}
+export interface PwSigninRequest {
+    signInRequest: SignInRequest;
+}
+export interface RefreshUatRequest {
+    tenantId?: string;
+    ksUat?: string;
+}
+export interface ResetPasswordRequest {
+    passwordResetRequest: PasswordResetRequest;
+    ksUat?: string;
+}
+export interface ResetPasswordWithTokenRequest {
+    passwordResetWithTokenRequest: PasswordResetWithTokenRequest;
+}
+export interface SendPwResetEmailRequest {
+    emailVerificationRequest: EmailVerificationRequest;
+}
+/**
+ * AuthApi - interface
+ *
+ * @export
+ * @interface AuthApiInterface
+ */
+export interface AuthApiInterface {
+    /**
+     *
+     * @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>;
+    /**
+     * 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<any>>;
+    /**
+     * Initiate SSO with the given provider and tenant ID.
+     * Initiate Sso Handler
+     */
+    initiateSso(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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} [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>;
+    /**
+     * Reset password for the authenticated user
+     * @summary Reset Password Handler
+     * @param {PasswordResetRequest} passwordResetRequest
+     * @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>;
+    /**
+     * 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>;
+    /**
+     *
+     * @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>;
+    /**
+     *
+     * @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 {
+    /**
+     * 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>;
+    /**
+     * Initiate SSO with the given provider and tenant ID.
+     * Initiate Sso Handler
+     */
+    initiateSsoRaw(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Initiate SSO with the given provider and tenant ID.
+     * Initiate Sso Handler
+     */
+    initiateSso(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * Signout Handler
+     */
+    signoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Signout Handler
+     */
+    signout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+}