@knowledge-stack/ksapi 1.87.0 → 1.88.0

package/dist/apis/AuthApi.js

@@ -62,6 +62,51 @@ const index_1 = require("../models/index");
  *
  */
 class AuthApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for changePhoneNumber without sending the request
+     */
+    changePhoneNumberRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['changePhoneNumberRequest'] == null) {
+                throw new runtime.RequiredError('changePhoneNumberRequest', 'Required parameter "changePhoneNumberRequest" was null or undefined when calling changePhoneNumber().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/auth/pw/me/phone_number`;
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ChangePhoneNumberRequestToJSON)(requestParameters['changePhoneNumberRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.changePhoneNumberRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.changePhoneNumberRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for createPasswordUser without sending the request
      */
@@ -102,6 +147,48 @@ class AuthApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for createPhonePasswordUser without sending the request
+     */
+    createPhonePasswordUserRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createPhonePasswordUserRequest'] == null) {
+                throw new runtime.RequiredError('createPhonePasswordUserRequest', 'Required parameter "createPhonePasswordUserRequest" was null or undefined when calling createPhonePasswordUser().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/auth/pw/phone_user`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreatePhonePasswordUserRequestToJSON)(requestParameters['createPhonePasswordUserRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createPhonePasswordUserRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createPhonePasswordUserRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for fanweiDirectorySync without sending the request
      */
@@ -336,6 +423,48 @@ class AuthApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for pwPhoneVerification without sending the request
+     */
+    pwPhoneVerificationRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['phoneVerificationRequest'] == null) {
+                throw new runtime.RequiredError('phoneVerificationRequest', 'Required parameter "phoneVerificationRequest" was null or undefined when calling pwPhoneVerification().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/auth/pw/phone_verification`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.PhoneVerificationRequestToJSON)(requestParameters['phoneVerificationRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.pwPhoneVerificationRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PhoneValidationResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.pwPhoneVerificationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for pwSignin without sending the request
      */
@@ -421,6 +550,51 @@ class AuthApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for requestPhoneChange without sending the request
+     */
+    requestPhoneChangeRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['requestPhoneChangeRequest'] == null) {
+                throw new runtime.RequiredError('requestPhoneChangeRequest', 'Required parameter "requestPhoneChangeRequest" was null or undefined when calling requestPhoneChange().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/auth/pw/me/phone_number/verify`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.RequestPhoneChangeRequestToJSON)(requestParameters['requestPhoneChangeRequest']),
+            };
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.requestPhoneChangeRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PhoneValidationResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * 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, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.requestPhoneChangeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for resetPassword without sending the request
      */
@@ -488,7 +662,7 @@ class AuthApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reset password with email verification token
+     * Reset password with a single-use PasswordResetToken JWT
      * Reset Password With Token Handler
      */
     resetPasswordWithTokenRaw(requestParameters, initOverrides) {
@@ -499,7 +673,7 @@ class AuthApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reset password with email verification token
+     * Reset password with a single-use PasswordResetToken JWT
      * Reset Password With Token Handler
      */
     resetPasswordWithToken(requestParameters, initOverrides) {
@@ -513,8 +687,8 @@ class AuthApi extends runtime.BaseAPI {
      */
     sendPwResetEmailRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (requestParameters['emailVerificationRequest'] == null) {
-                throw new runtime.RequiredError('emailVerificationRequest', 'Required parameter "emailVerificationRequest" was null or undefined when calling sendPwResetEmail().');
+            if (requestParameters['sendPasswordResetRequest'] == null) {
+                throw new runtime.RequiredError('sendPasswordResetRequest', 'Required parameter "sendPasswordResetRequest" was null or undefined when calling sendPwResetEmail().');
             }
             const queryParameters = {};
             const headerParameters = {};
@@ -525,21 +699,23 @@ class AuthApi extends runtime.BaseAPI {
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.EmailVerificationRequestToJSON)(requestParameters['emailVerificationRequest']),
+                body: (0, index_1.SendPasswordResetRequestToJSON)(requestParameters['sendPasswordResetRequest']),
             };
         });
     }
     /**
+     * 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, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.sendPwResetEmailRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EmailSentResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ResponseSendPwResetEmailFromJSON)(jsonValue));
         });
     }
     /**
+     * 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, initOverrides) {
@@ -631,5 +807,47 @@ class AuthApi extends runtime.BaseAPI {
             yield this.ssoSigninRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for validatePwResetCode without sending the request
+     */
+    validatePwResetCodeRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['validateResetCodeRequest'] == null) {
+                throw new runtime.RequiredError('validateResetCodeRequest', 'Required parameter "validateResetCodeRequest" was null or undefined when calling validatePwResetCode().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/auth/pw/validate_reset_code`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ValidateResetCodeRequestToJSON)(requestParameters['validateResetCodeRequest']),
+            };
+        });
+    }
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * Validate Reset Code Handler
+     */
+    validatePwResetCodeRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.validatePwResetCodeRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PasswordResetTokenResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Validate an SMS reset code and return a single-use reset JWT.
+     * Validate Reset Code Handler
+     */
+    validatePwResetCode(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.validatePwResetCodeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 exports.AuthApi = AuthApi;