@knowledge-stack/ksapi 1.87.1 → 1.88.0

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

@@ -10,10 +10,18 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreatePasswordUserRequest, DirectorySyncResponse, EmailSentResponse, EmailVerificationRequest, IdpType, PasswordResetRequest, PasswordResetWithTokenRequest, SSOInitiateResponse, SignInRequest, UserResponse } from '../models/index';
+import type { ChangePhoneNumberRequest, CreatePasswordUserRequest, CreatePhonePasswordUserRequest, DirectorySyncResponse, EmailSentResponse, EmailVerificationRequest, IdpType, PasswordResetRequest, PasswordResetTokenResponse, PasswordResetWithTokenRequest, PhoneValidationResponse, PhoneVerificationRequest, RequestPhoneChangeRequest, ResponseSendPwResetEmail, SSOInitiateResponse, SendPasswordResetRequest, SignInRequest, UserResponse, ValidateResetCodeRequest } from '../models/index';
+export interface ChangePhoneNumberOperationRequest {
+    changePhoneNumberRequest: ChangePhoneNumberRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
 export interface CreatePasswordUserOperationRequest {
     createPasswordUserRequest: CreatePasswordUserRequest;
 }
+export interface CreatePhonePasswordUserOperationRequest {
+    createPhonePasswordUserRequest: CreatePhonePasswordUserRequest;
+}
 export interface FanweiDirectorySyncRequest {
     tenantId: string;
     authorization?: string | null;
@@ -39,6 +47,9 @@ export interface Oauth2CallbackRequest {
 export interface PwEmailVerificationRequest {
     emailVerificationRequest: EmailVerificationRequest;
 }
+export interface PwPhoneVerificationRequest {
+    phoneVerificationRequest: PhoneVerificationRequest;
+}
 export interface PwSigninRequest {
     signInRequest: SignInRequest;
 }
@@ -47,6 +58,11 @@ export interface RefreshUatRequest {
     authorization?: string | null;
     ksUat?: string | null;
 }
+export interface RequestPhoneChangeOperationRequest {
+    requestPhoneChangeRequest: RequestPhoneChangeRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
 export interface ResetPasswordRequest {
     passwordResetRequest: PasswordResetRequest;
     authorization?: string | null;
@@ -56,12 +72,15 @@ export interface ResetPasswordWithTokenRequest {
     passwordResetWithTokenRequest: PasswordResetWithTokenRequest;
 }
 export interface SendPwResetEmailRequest {
-    emailVerificationRequest: EmailVerificationRequest;
+    sendPasswordResetRequest: SendPasswordResetRequest;
 }
 export interface SsoSigninRequest {
     tenantId: string;
     redirect?: string;
 }
+export interface ValidatePwResetCodeRequest {
+    validateResetCodeRequest: ValidateResetCodeRequest;
+}
 /**
  * AuthApi - interface
  *
@@ -69,6 +88,31 @@ export interface SsoSigninRequest {
  * @interface AuthApiInterface
  */
 export interface AuthApiInterface {
+    /**
+     * Creates request options for changePhoneNumber without sending the request
+     * @param {ChangePhoneNumberRequest} changePhoneNumberRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    changePhoneNumberRequestOpts(requestParameters: ChangePhoneNumberOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Apply a verified phone-number change to the authenticated user.  The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
+     * @summary Change Phone Number Handler
+     * @param {ChangePhoneNumberRequest} changePhoneNumberRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    changePhoneNumberRaw(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    /**
+     * Apply a verified phone-number change to the authenticated user.  The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
+     * Change Phone Number Handler
+     */
+    changePhoneNumber(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
     /**
      * Creates request options for createPasswordUser without sending the request
      * @param {CreatePasswordUserRequest} createPasswordUserRequest
@@ -89,6 +133,27 @@ export interface AuthApiInterface {
      * Create Password User Handler
      */
     createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    /**
+     * Creates request options for createPhonePasswordUser without sending the request
+     * @param {CreatePhonePasswordUserRequest} createPhonePasswordUserRequest
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    createPhonePasswordUserRequestOpts(requestParameters: CreatePhonePasswordUserOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Complete phone-based signup using a verified validation code.  The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
+     * @summary Create Phone Password User Handler
+     * @param {CreatePhonePasswordUserRequest} createPhonePasswordUserRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    createPhonePasswordUserRaw(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    /**
+     * Complete phone-based signup using a verified validation code.  The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
+     * Create Phone Password User Handler
+     */
+    createPhonePasswordUser(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
     /**
      * Creates request options for fanweiDirectorySync without sending the request
      * @param {string} tenantId
@@ -214,6 +279,27 @@ export interface AuthApiInterface {
      * Pw Email Verification Handler
      */
     pwEmailVerification(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
+    /**
+     * Creates request options for pwPhoneVerification without sending the request
+     * @param {PhoneVerificationRequest} phoneVerificationRequest
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    pwPhoneVerificationRequestOpts(requestParameters: PwPhoneVerificationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a 6-digit signup verification code to ``phone_number``.  Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
+     * @summary Pw Phone Verification Handler
+     * @param {PhoneVerificationRequest} phoneVerificationRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    pwPhoneVerificationRaw(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
+    /**
+     * Send a 6-digit signup verification code to ``phone_number``.  Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
+     * Pw Phone Verification Handler
+     */
+    pwPhoneVerification(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
     /**
      * Creates request options for pwSignin without sending the request
      * @param {SignInRequest} signInRequest
@@ -260,6 +346,31 @@ export interface AuthApiInterface {
      * Refresh Uat Handler
      */
     refreshUat(requestParameters: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    /**
+     * Creates request options for requestPhoneChange without sending the request
+     * @param {RequestPhoneChangeRequest} requestPhoneChangeRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    requestPhoneChangeRequestOpts(requestParameters: RequestPhoneChangeOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Dispatch an SMS code to authorize a phone-number change.  Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
+     * @summary Request Phone Change Handler
+     * @param {RequestPhoneChangeRequest} requestPhoneChangeRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    requestPhoneChangeRaw(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
+    /**
+     * Dispatch an SMS code to authorize a phone-number change.  Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
+     * Request Phone Change Handler
+     */
+    requestPhoneChange(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
     /**
      * Creates request options for resetPassword without sending the request
      * @param {PasswordResetRequest} passwordResetRequest
@@ -293,7 +404,7 @@ export interface AuthApiInterface {
      */
     resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts>;
     /**
-     * Reset password with email verification token
+     * Reset password with a single-use PasswordResetToken JWT
      * @summary Reset Password With Token Handler
      * @param {PasswordResetWithTokenRequest} passwordResetWithTokenRequest
      * @param {*} [options] Override http request option.
@@ -302,30 +413,31 @@ export interface AuthApiInterface {
      */
     resetPasswordWithTokenRaw(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
     /**
-     * Reset password with email verification token
+     * Reset password with a single-use PasswordResetToken JWT
      * 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
+     * @param {SendPasswordResetRequest} sendPasswordResetRequest
      * @throws {RequiredError}
      * @memberof AuthApiInterface
      */
     sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts>;
     /**
-     *
+     * Initiate a password reset via the requested ``method``.  ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
      * @summary Send Pw Reset Email Handler
-     * @param {EmailVerificationRequest} emailVerificationRequest
+     * @param {SendPasswordResetRequest} sendPasswordResetRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AuthApiInterface
      */
-    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
+    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseSendPwResetEmail>>;
     /**
+     * Initiate a password reset via the requested ``method``.  ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
      * Send Pw Reset Email Handler
      */
-    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
+    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseSendPwResetEmail>;
     /**
      * Creates request options for signout without sending the request
      * @throws {RequiredError}
@@ -367,11 +479,46 @@ export interface AuthApiInterface {
      * Sso Login Handler
      */
     ssoSignin(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for validatePwResetCode without sending the request
+     * @param {ValidateResetCodeRequest} validateResetCodeRequest
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    validatePwResetCodeRequestOpts(requestParameters: ValidatePwResetCodeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * @summary Validate Reset Code Handler
+     * @param {ValidateResetCodeRequest} validateResetCodeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthApiInterface
+     */
+    validatePwResetCodeRaw(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordResetTokenResponse>>;
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * Validate Reset Code Handler
+     */
+    validatePwResetCode(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordResetTokenResponse>;
 }
 /**
  *
  */
 export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
+    /**
+     * Creates request options for changePhoneNumber without sending the request
+     */
+    changePhoneNumberRequestOpts(requestParameters: ChangePhoneNumberOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Apply a verified phone-number change to the authenticated user.  The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
+     * Change Phone Number Handler
+     */
+    changePhoneNumberRaw(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    /**
+     * Apply a verified phone-number change to the authenticated user.  The new phone is read from the Redis validation record pinned by ``/me/phone_number/verify``.
+     * Change Phone Number Handler
+     */
+    changePhoneNumber(requestParameters: ChangePhoneNumberOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
     /**
      * Creates request options for createPasswordUser without sending the request
      */
@@ -384,6 +531,20 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      * Create Password User Handler
      */
     createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    /**
+     * Creates request options for createPhonePasswordUser without sending the request
+     */
+    createPhonePasswordUserRequestOpts(requestParameters: CreatePhonePasswordUserOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Complete phone-based signup using a verified validation code.  The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
+     * Create Phone Password User Handler
+     */
+    createPhonePasswordUserRaw(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    /**
+     * Complete phone-based signup using a verified validation code.  The phone number is read from the Redis validation record — it was pinned there by ``/phone_verification`` — so the client cannot submit a different phone here than the one it just proved ownership of.
+     * Create Phone Password User Handler
+     */
+    createPhonePasswordUser(requestParameters: CreatePhonePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
     /**
      * Creates request options for fanweiDirectorySync without sending the request
      */
@@ -454,6 +615,20 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      * Pw Email Verification Handler
      */
     pwEmailVerification(requestParameters: PwEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
+    /**
+     * Creates request options for pwPhoneVerification without sending the request
+     */
+    pwPhoneVerificationRequestOpts(requestParameters: PwPhoneVerificationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a 6-digit signup verification code to ``phone_number``.  Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
+     * Pw Phone Verification Handler
+     */
+    pwPhoneVerificationRaw(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
+    /**
+     * Send a 6-digit signup verification code to ``phone_number``.  Rejects (409) if a user already exists for this phone — this leaks enumeration but matches the duplicate-signup UX of the email flow.
+     * Pw Phone Verification Handler
+     */
+    pwPhoneVerification(requestParameters: PwPhoneVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
     /**
      * Creates request options for pwSignin without sending the request
      */
@@ -482,6 +657,20 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      * Refresh Uat Handler
      */
     refreshUat(requestParameters?: RefreshUatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    /**
+     * Creates request options for requestPhoneChange without sending the request
+     */
+    requestPhoneChangeRequestOpts(requestParameters: RequestPhoneChangeOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Dispatch an SMS code to authorize a phone-number change.  Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
+     * Request Phone Change Handler
+     */
+    requestPhoneChangeRaw(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PhoneValidationResponse>>;
+    /**
+     * Dispatch an SMS code to authorize a phone-number change.  Confirms the new phone isn\'t already taken by *another* user. The caller is identified by their UAT, so authentication is required.
+     * Request Phone Change Handler
+     */
+    requestPhoneChange(requestParameters: RequestPhoneChangeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PhoneValidationResponse>;
     /**
      * Creates request options for resetPassword without sending the request
      */
@@ -501,12 +690,12 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      */
     resetPasswordWithTokenRequestOpts(requestParameters: ResetPasswordWithTokenRequest): Promise<runtime.RequestOpts>;
     /**
-     * Reset password with email verification token
+     * Reset password with a single-use PasswordResetToken JWT
      * 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 a single-use PasswordResetToken JWT
      * Reset Password With Token Handler
      */
     resetPasswordWithToken(requestParameters: ResetPasswordWithTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
@@ -515,13 +704,15 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      */
     sendPwResetEmailRequestOpts(requestParameters: SendPwResetEmailRequest): Promise<runtime.RequestOpts>;
     /**
+     * Initiate a password reset via the requested ``method``.  ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
      * Send Pw Reset Email Handler
      */
-    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSentResponse>>;
+    sendPwResetEmailRaw(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseSendPwResetEmail>>;
     /**
+     * Initiate a password reset via the requested ``method``.  ``method=EMAIL`` (default) mints a ``PasswordResetToken`` and sends the existing reset email. ``method=SMS`` looks up the user by phone, dispatches an SMS verification code, and the caller must follow up with ``/validate_reset_code``.
      * Send Pw Reset Email Handler
      */
-    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSentResponse>;
+    sendPwResetEmail(requestParameters: SendPwResetEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseSendPwResetEmail>;
     /**
      * Creates request options for signout without sending the request
      */
@@ -548,4 +739,18 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
      * Sso Login Handler
      */
     ssoSignin(requestParameters: SsoSigninRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for validatePwResetCode without sending the request
+     */
+    validatePwResetCodeRequestOpts(requestParameters: ValidatePwResetCodeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * Validate Reset Code Handler
+     */
+    validatePwResetCodeRaw(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasswordResetTokenResponse>>;
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * Validate Reset Code Handler
+     */
+    validatePwResetCode(requestParameters: ValidatePwResetCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasswordResetTokenResponse>;
 }