@stackfactor/client-api 1.1.218 → 1.1.220

package/dist/esm/lib/users.js

@@ -0,0 +1,693 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateResetPasswordCode = exports.updateUserPassword = exports.updateUserGroups = exports.updateUserEmail = exports.setUserInformation = exports.sendPasswordResetNotification = exports.sendEmailConfirmationCode = exports.resetPassword = exports.resendInvitationEmails = exports.removeAPIToken = exports.refreshToken = exports.logout = exports.loginExchangeKeys = exports.login = exports.inviteUsers = exports.getUsers = exports.getUserInformation = exports.getUserById = exports.getAPITokens = exports.deleteUsers = exports.deleteAPIToken = exports.createUserAccount = exports.createAccount = exports.confirmPhoneGenerateCode = exports.confirmPhone = exports.confirmEmailAddress = exports.addAPIToken = void 0;
+const axiosClient_js_1 = require("./axiosClient.js");
+/**
+ * Add a new API Token
+ * @param {string} name Name of the token
+ * @param {Date} expiration Expiration date of the token
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const addAPIToken = (name, expiration, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            name: name,
+            expiration: expiration,
+        };
+        const addTokenRequest = axiosClient_js_1.client.post(`/api/v1/users/addapitoken`, requestData, {
+            headers: { authorization: token },
+        });
+        addTokenRequest
+            .then((result) => {
+            if (result != null) {
+                resolve(result.data);
+            }
+            else {
+                reject(process.env.ERROR_INVALID_INFORMATION);
+            }
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.addAPIToken = addAPIToken;
+/**
+ * Confirm email address
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @returns {Promise<void>}
+ */
+const confirmEmailAddress = (validationCode) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            validationCode: validationCode,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/confirmEmail", requestData);
+        confirmationRequest
+            .then(() => {
+            resolve();
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.confirmEmailAddress = confirmEmailAddress;
+/**
+ * Confirm phone number
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const confirmPhone = (validationCode, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            validationCode: validationCode,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/confirmPhone", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.confirmPhone = confirmPhone;
+/**
+ * Generate confirmation code
+ * @param {string} phoneNumber Send confirmation code to the phone number
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const confirmPhoneGenerateCode = (phoneNumber, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            phoneNumber: phoneNumber,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/confirmPhoneGenerateCode", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.confirmPhoneGenerateCode = confirmPhoneGenerateCode;
+/**
+ * Create a new account (tenant). It returns a promise
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} subSite Subsite where the new account will be created
+ * @param {string} inviteCode Invitation code received in advance from one of the account owners
+ * @returns {Promise<object>}
+ */
+const createAccount = (email, firstName, lastName, password, subSite, inviteCode) => {
+    return new Promise((resolve, reject) => {
+        if (email.trim() === "" ||
+            firstName.trim() === "" ||
+            lastName.trim() === "" ||
+            password.trim() === "" ||
+            subSite.trim() === "" ||
+            inviteCode.trim() === "") {
+            reject(process.env.ERROR_EMPTY_FIELDS);
+        }
+        else {
+            const signupData = {
+                email: email,
+                firstName: firstName,
+                inviteCode: inviteCode,
+                lastName: lastName,
+                password: password,
+                subSite: subSite,
+            };
+            const request = axiosClient_js_1.client.post("/api/v1/users/createAccount", signupData);
+            request
+                .then((result) => {
+                resolve(result.data.user);
+            })
+                .catch((error) => {
+                reject(error);
+            });
+        }
+    });
+};
+exports.createAccount = createAccount;
+/**
+ * Create a new user account. It returns a promise
+ * @param {string} email User's email address
+ * @param {string} firstName User's first name
+ * @param {string} lastName User's last name
+ * @param {string} password User's password
+ * @param {string} token Invitation token provided to the user
+ * @returns {Promise<object>}
+ */
+const createUserAccount = (email, firstName, lastName, password, token) => {
+    return new Promise((resolve, reject) => {
+        if (email.trim() === "" ||
+            firstName.trim() === "" ||
+            lastName.trim() === "" ||
+            password.trim() === "" ||
+            token.trim() === "") {
+            reject(process.env.ERROR_EMPTY_FIELDS);
+        }
+        else {
+            const signupData = {
+                email: email,
+                firstName: firstName,
+                lastName: lastName,
+                password: password,
+                token: token,
+            };
+            const request = axiosClient_js_1.client.post("/api/v1/users/createUser", signupData);
+            request
+                .then((result) => {
+                resolve(result.data.user);
+            })
+                .catch((error) => {
+                reject(error);
+            });
+        }
+    });
+};
+exports.createUserAccount = createUserAccount;
+/**
+ * Delete an existing API token
+ * @param {string} token Expiration date of the token
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+const deleteAPIToken = (token, authToken) => {
+    return new Promise((resolve, reject) => {
+        const deleteTokenRequest = axiosClient_js_1.client.delete(`/api/v1/users/user/token`, {
+            headers: { authorization: authToken },
+            data: {
+                token: token,
+            },
+        });
+        deleteTokenRequest
+            .then(() => {
+            resolve(token);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.deleteAPIToken = deleteAPIToken;
+/**
+ * Delete existing users
+ * @param {string[]} userIds The ID of the users to be deleted
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const deleteUsers = (userIds, token) => {
+    return new Promise((resolve, reject) => {
+        const deleteTokenRequest = axiosClient_js_1.client.delete(`/api/v1/users/`, {
+            headers: { authorization: token },
+            data: {
+                userIds: userIds,
+            },
+        });
+        deleteTokenRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.deleteUsers = deleteUsers;
+/**
+ * Get all the API tokens
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const getAPITokens = (token) => {
+    return new Promise((resolve, reject) => {
+        const getTokensRequest = axiosClient_js_1.client.get(`/api/v1/users/getapitokens`, {
+            headers: { authorization: token },
+        });
+        getTokensRequest
+            .then((result) => {
+            resolve(result.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getAPITokens = getAPITokens;
+/**
+ * Get the specified user account by Id. It returns a promise
+ * @param {string} id Id of the user for which information is being requested
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const getUserById = (id, token) => {
+    return new Promise((resolve, reject) => {
+        const getUserInformationRequest = axiosClient_js_1.client.get(`/api/v1/users/user/${id}`, {
+            headers: { authorization: token },
+        });
+        getUserInformationRequest
+            .then((result) => {
+            if (result != null) {
+                resolve(result.data.user);
+            }
+            else {
+                reject(process.env.ERROR_INVALID_INFORMATION);
+            }
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getUserById = getUserById;
+/**
+ * Get user information
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const getUserInformation = (userId, category, token) => {
+    return new Promise((resolve, reject) => {
+        const confirmationRequest = axiosClient_js_1.client.get(`/api/v1/users/user/${userId || 0}/${category || "*"}`, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getUserInformation = getUserInformation;
+/**
+ * Get the list of users
+ * @param {object} filter Filter to select the users. Ex: {firstName : "John"}
+ * @param {string[]} fields Fields to be loaded. Ex: ["firstName"]
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const getUsers = (filter, fields, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            filter: filter,
+            fields: fields,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post(`/api/v1/users/`, requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getUsers = getUsers;
+/**
+ * Invite other users to join the same account
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} groupId The group the user should be added to
+ * @param {string} teamId The team the user should be added to
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
+ */
+const inviteUsers = (invitees, groupId, teamId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            invitees: invitees,
+            groupId: groupId,
+            teamId: teamId,
+            token: authToken,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/invite", requestData, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.inviteUsers = inviteUsers;
+/**
+ * Login using email and password. It returns a promise
+ * @param {string} email User's email address
+ * @param {string} password User's password
+ * @returns {Promise<object>}
+ */
+const login = (email, password) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            email: email,
+            password: password,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/auth/login", requestData);
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.login = login;
+/**
+ * Login callback after authentication to exchange the code token for authentication and refresh tokens
+ * @param {string} code
+ * @param {string} codeVerifier
+ * @param {string} redirectUri
+ * @returns {Promise<object>}
+ */
+const loginExchangeKeys = (code, codeVerifier, redirectUri) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            code: code,
+            codeVerifier: codeVerifier,
+            redirectUri: redirectUri,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/auth/loginexchangekeys", requestData);
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.loginExchangeKeys = loginExchangeKeys;
+/**
+ * Logout from the server. It returns a promise
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const logout = (token) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post("/api/v1/auth/logout", {}, {
+            headers: { authorization: token },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.logout = logout;
+/**
+ * Checks the current auth token and maintain it alive. It returns a promise. In case the token is invalid
+ * a new token can be restablished using login
+ * @param {string} refreshToken User's auth token to be refreshed
+ * @returns {Promise<object>}
+ */
+const refreshToken = (refreshToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post("/api/v1/auth/refreshToken", {
+            refreshToken: refreshToken,
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.refreshToken = refreshToken;
+/**
+ * Remove an existing API token
+ * @param {string} id The ID of the token to be removed
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+const removeAPIToken = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            id: id,
+        };
+        const removeTokenRequest = axiosClient_js_1.client.post(`/api/v1/users/removeapitoken`, requestData, {
+            headers: { authorization: authToken },
+        });
+        removeTokenRequest
+            .then(() => {
+            resolve(id);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.removeAPIToken = removeAPIToken;
+/**
+ * Resend invitation emails
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
+ */
+const resendInvitationEmails = (invitees, authToken) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            invitees: invitees,
+            token: authToken,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/resendinvite", requestData, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.resendInvitationEmails = resendInvitationEmails;
+/**
+ * Reset the password. It returns a promise
+ * @param {string} code Code provided to the user by email
+ * @param {string} email User's email address
+ * @param {string} password User's new password
+ * @returns {Promise<object>}
+ */
+const resetPassword = (email, code, password) => {
+    return new Promise((resolve, reject) => {
+        const postData = {
+            email: email,
+            code: code,
+            password: password,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/resetpassword", postData);
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.resetPassword = resetPassword;
+/**
+ * Send email confirmation code
+ * @param {string} email
+ * @param {string} token
+ * @returns {Promise<object>}
+ */
+const sendEmailConfirmationCode = (email, token) => {
+    return new Promise((resolve, reject) => {
+        const postData = {
+            email: email,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/sendemailconfirmationcode", postData, {
+            headers: { authorization: token },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.sendEmailConfirmationCode = sendEmailConfirmationCode;
+/**
+ * Send an email to the user indicated by the email address to reset the password. It returns a promise
+ * @param {string} email Email of the user who needs to reset the password
+ * @returns {Promise<object>}
+ */
+const sendPasswordResetNotification = (email) => {
+    return new Promise((resolve, reject) => {
+        const postData = {
+            email: email,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/sendpasswordresetnotification", postData);
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.sendPasswordResetNotification = sendPasswordResetNotification;
+/**
+ * Set user profile information
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {object} data New or updated user data information
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const setUserInformation = (userId, category, data, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            data: category ? { [category]: data } : data,
+            userId: userId,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/user", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.setUserInformation = setUserInformation;
+/**
+ * Update user email
+ * @param {string} email The new email address
+ * @param {string} verificationCode The verification code
+ * @param {string} password The current password
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+const updateUserEmail = (email, verificationCode, password, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            email: email,
+            verificationCode: verificationCode,
+            password: password,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/updateemail", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.updateUserEmail = updateUserEmail;
+/**
+ * Update user groups
+ * @param {String} userId The id of the user
+ * @param {Array<String>} groups The id of the groups the user should belong to
+ * @param {String} token Authorization token
+ * @returns {Promise<object>}
+ */
+const updateUserGroups = (userId, groups, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            userId: userId,
+            groups: groups || [],
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/user/updategroups", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(() => {
+            resolve(requestData);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.updateUserGroups = updateUserGroups;
+/**
+ * Update user password
+ * @param {String} password The current password
+ * @param {String} newPassword The new password
+ * @param {String} token Authorization token
+ * @returns {Promise<object>}
+ */
+const updateUserPassword = (password, newPassword, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            password: password,
+            newPassword: newPassword,
+        };
+        const confirmationRequest = axiosClient_js_1.client.post("/api/v1/users/updatepassword", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.updateUserPassword = updateUserPassword;
+/**
+ * Validate reset password code. It returns a promise
+ * @param {String} email User's email address
+ * @param {String} code Provided reset code
+ * @returns {Promise<object>}
+ */
+const validateResetPasswordCode = (email, code) => {
+    return new Promise((resolve, reject) => {
+        const postData = {
+            email: email,
+            code: code,
+        };
+        const request = axiosClient_js_1.client.post("/api/v1/users/validateresetpasswordcode", postData);
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.validateResetPasswordCode = validateResetPasswordCode;
+//# sourceMappingURL=users.js.map