musora-content-services 2.33.0 → 2.33.1

package/src/services/user/account.ts

@@ -12,6 +12,10 @@ export interface PasswordResetProps {
   token: string
 }
 
+/**
+ * @param {string} email - The email address to check the account status for.
+ * @returns {Promise<{requires_setup: boolean}|HttpError>} - A promise that resolves to an object indicating whether account setup is required, or an HttpError if the request fails.
+ */
 export async function status(email: string): Promise<{ requires_setup: boolean } | HttpError> {
   const httpClient = new HttpClient(globalConfig.baseUrl)
   const response = await httpClient.get<{ requires_setup: boolean }>(
@@ -20,6 +24,10 @@ export async function status(email: string): Promise<{ requires_setup: boolean }
   return response
 }
 
+/**
+ * @param {string} email - The email address to send the account setup email to.
+ * @returns {Promise<void|HttpError>} - A promise that resolves when the email is sent or an HttpError if the request fails.
+ */
 export async function sendAccountSetupEmail(email: string): Promise<void | HttpError> {
   const httpClient = new HttpClient(globalConfig.baseUrl)
   return httpClient.post<void>(
@@ -28,6 +36,14 @@ export async function sendAccountSetupEmail(email: string): Promise<void | HttpE
   )
 }
 
+/**
+ * @param {Object} params - The parameters for setting up the account.
+ * @property {string} email - The email address for the account.
+ * @property {string} password - The new password for the account.
+ * @property {string} passwordConfirmation - The confirmation of the new password.
+ * @property {string} token - The token sent to the user's email for verification.
+ * @returns {Promise<void|HttpError>} - A promise that resolves when the account setup is complete or an HttpError if the request fails.
+ */
 export async function setupAccount({
   email,
   password,
@@ -43,6 +59,10 @@ export async function setupAccount({
   })
 }
 
+/**
+ * @param {string} email - The email address to send the password reset email to.
+ * @returns {Promise<void|HttpError>} - A promise that resolves when the email change request is made.
+ */
 export async function sendPasswordResetEmail(email: string): Promise<void | HttpError> {
   const httpClient = new HttpClient(globalConfig.baseUrl)
   return httpClient.post(`/api/user-management-system/v1/accounts/password/reset-email`, {
@@ -50,6 +70,14 @@ export async function sendPasswordResetEmail(email: string): Promise<void | Http
   })
 }
 
+/**
+ * @param {Object} params - The parameters for resetting the password.
+ * @property {string} email - The email address for the account.
+ * @property {string} password - The new password for the account.
+ * @property {string} passwordConfirmation - The confirmation of the new password.
+ * @property {string} token - The token sent to the user's email for verification.
+ * @returns {Promise<void|HttpError>} - A promise that resolves when the password reset is complete or an HttpError if the request fails.
+ */
 export async function resetPassword({
   email,
   password,