@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/src/apis/AuthApi.ts

@@ -97,6 +97,14 @@ export interface SendPwResetEmailRequest {
  * @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
@@ -112,6 +120,15 @@ export interface AuthApiInterface {
      */
     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
@@ -129,6 +146,19 @@ export interface AuthApiInterface {
      */
     initiateSso(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
 
+    /**
+     * 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
@@ -150,6 +180,14 @@ export interface AuthApiInterface {
      */
     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
@@ -166,6 +204,14 @@ export interface AuthApiInterface {
      */
     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
@@ -182,6 +228,15 @@ export interface AuthApiInterface {
      */
     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} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    refreshUatRequestOpts(requestParameters: RefreshUatRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Refresh or switch the user\'s active tenant token.
      * @summary Refresh Uat Handler
@@ -199,6 +254,15 @@ export interface AuthApiInterface {
      */
     refreshUat(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
+    /**
+     * Creates request options for resetPassword without sending the request
+     * @param {PasswordResetRequest} passwordResetRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Reset password for the authenticated user
      * @summary Reset Password Handler
@@ -216,6 +280,14 @@ export interface AuthApiInterface {
      */
     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
@@ -232,6 +304,14 @@ export interface AuthApiInterface {
      */
     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
@@ -247,6 +327,13 @@ export interface AuthApiInterface {
      */
     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
@@ -269,9 +356,9 @@ export interface AuthApiInterface {
 export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
     /**
-     * Create Password User Handler
+     * Creates request options for createPasswordUser without sending the request
      */
-    async createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async createPasswordUserRequestOpts(requestParameters: CreatePasswordUserOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createPasswordUserRequest'] == null) {
             throw new runtime.RequiredError(
                 'createPasswordUserRequest',
@@ -288,13 +375,21 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/user`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreatePasswordUserRequestToJSON(requestParameters['createPasswordUserRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create Password User Handler
+     */
+    async createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.createPasswordUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -308,10 +403,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Initiate SSO with the given provider and tenant ID.
-     * Initiate Sso Handler
+     * Creates request options for initiateSso without sending the request
      */
-    async initiateSsoRaw(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+    async initiateSsoRequestOpts(requestParameters: InitiateSsoRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['provider'] == null) {
             throw new runtime.RequiredError(
                 'provider',
@@ -334,12 +428,21 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/sso/initiate`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Initiate SSO with the given provider and tenant ID.
+     * Initiate Sso Handler
+     */
+    async initiateSsoRaw(requestParameters: InitiateSsoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+        const requestOptions = await this.initiateSsoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         if (this.isJsonMime(response.headers.get('content-type'))) {
             return new runtime.JSONApiResponse<any>(response);
@@ -358,10 +461,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Handle OAuth2 callback from the given OAuth client.
-     * Oauth2 Callback Handler
+     * Creates request options for oauth2Callback without sending the request
      */
-    async oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async oauth2CallbackRequestOpts(requestParameters: Oauth2CallbackRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['provider'] == null) {
             throw new runtime.RequiredError(
                 'provider',
@@ -400,12 +502,21 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/sso/oauth2/callback`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Handle OAuth2 callback from the given OAuth client.
+     * Oauth2 Callback Handler
+     */
+    async oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.oauth2CallbackRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -420,10 +531,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * 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
+     * Creates request options for pwEmailVerification without sending the request
      */
-    async pwEmailVerificationRaw(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>> {
+    async pwEmailVerificationRequestOpts(requestParameters: PwEmailVerificationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['emailVerificationRequest'] == null) {
             throw new runtime.RequiredError(
                 'emailVerificationRequest',
@@ -440,13 +550,22 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/email_verification`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: EmailVerificationRequestToJSON(requestParameters['emailVerificationRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async pwEmailVerificationRaw(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>> {
+        const requestOptions = await this.pwEmailVerificationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => EmailSentResponseFromJSON(jsonValue));
     }
@@ -461,10 +580,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * 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
+     * Creates request options for pwSignin without sending the request
      */
-    async pwSigninRaw(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async pwSigninRequestOpts(requestParameters: PwSigninRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['signInRequest'] == null) {
             throw new runtime.RequiredError(
                 'signInRequest',
@@ -481,13 +599,22 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/signin`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: SignInRequestToJSON(requestParameters['signInRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async pwSigninRaw(requestParameters: PwSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.pwSigninRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -502,10 +629,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Refresh or switch the user\'s active tenant token.
-     * Refresh Uat Handler
+     * Creates request options for refreshUat without sending the request
      */
-    async refreshUatRaw(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async refreshUatRequestOpts(requestParameters: RefreshUatRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['tenantId'] != null) {
@@ -517,12 +643,21 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/uat`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Refresh or switch the user\'s active tenant token.
+     * Refresh Uat Handler
+     */
+    async refreshUatRaw(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.refreshUatRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -537,10 +672,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Reset password for the authenticated user
-     * Reset Password Handler
+     * Creates request options for resetPassword without sending the request
      */
-    async resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async resetPasswordRequestOpts(requestParameters: ResetPasswordRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['passwordResetRequest'] == null) {
             throw new runtime.RequiredError(
                 'passwordResetRequest',
@@ -557,13 +691,22 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/reset`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PasswordResetRequestToJSON(requestParameters['passwordResetRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Reset password for the authenticated user
+     * Reset Password Handler
+     */
+    async resetPasswordRaw(requestParameters: ResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.resetPasswordRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -578,10 +721,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Reset password with email verification token
-     * Reset Password With Token Handler
+     * Creates request options for resetPasswordWithToken without sending the request
      */
-    async resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['passwordResetWithTokenRequest'] == null) {
             throw new runtime.RequiredError(
                 'passwordResetWithTokenRequest',
@@ -598,13 +740,22 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/reset_with_token`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PasswordResetWithTokenRequestToJSON(requestParameters['passwordResetWithTokenRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Reset password with email verification token
+     * Reset Password With Token Handler
+     */
+    async resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.resetPasswordWithTokenRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -619,9 +770,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Send Pw Reset Email Handler
+     * Creates request options for sendPwResetEmail without sending the request
      */
-    async sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>> {
+    async sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['emailVerificationRequest'] == null) {
             throw new runtime.RequiredError(
                 'emailVerificationRequest',
@@ -638,13 +789,21 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/pw/send_reset_email`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: EmailVerificationRequestToJSON(requestParameters['emailVerificationRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Send Pw Reset Email Handler
+     */
+    async sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>> {
+        const requestOptions = await this.sendPwResetEmailRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => EmailSentResponseFromJSON(jsonValue));
     }
@@ -658,9 +817,9 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     }
 
     /**
-     * Signout Handler
+     * Creates request options for signout without sending the request
      */
-    async signoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+    async signoutRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -668,12 +827,20 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         let urlPath = `/v1/auth/signout`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Signout Handler
+     */
+    async signoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
+        const requestOptions = await this.signoutRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
 
         if (this.isJsonMime(response.headers.get('content-type'))) {
             return new runtime.JSONApiResponse<any>(response);