@stackfactor/client-api 1.1.135 → 1.1.136

package/dist/cjs/users.js

@@ -0,0 +1,695 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var axiosClient_1 = require("./axiosClient");
+/**
+ * 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>}
+ */
+var addAPIToken = function (name, expiration, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            name: name,
+            expiration: expiration,
+        };
+        var addTokenRequest = axiosClient_1.client.post("api/v1/users/addapitoken", requestData, {
+            headers: { authorization: token },
+        });
+        addTokenRequest
+            .then(function (result) {
+            if (result != null) {
+                resolve(result.data);
+            }
+            else {
+                reject(process.env.ERROR_INVALID_INFORMATION);
+            }
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Confirm email address
+ * @param {string} validationCode The code was provided to the user in advance by email
+ * @returns {Promise<void>}
+ */
+var confirmEmailAddress = function (validationCode) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            validationCode: validationCode,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/confirmEmail", requestData);
+        confirmationRequest
+            .then(function () {
+            resolve();
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var confirmPhone = function (validationCode, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            validationCode: validationCode,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/confirmPhone", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Generate confirmation code
+ * @param {string} phoneNumber Send confirmation code to the phone number
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+var confirmPhoneGenerateCode = function (phoneNumber, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            phoneNumber: phoneNumber,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/confirmPhoneGenerateCode", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var createAccount = function (email, firstName, lastName, password, subSite, inviteCode) {
+    return new Promise(function (resolve, reject) {
+        if (email.trim() === "" ||
+            firstName.trim() === "" ||
+            lastName.trim() === "" ||
+            password.trim() === "" ||
+            subSite.trim() === "" ||
+            inviteCode.trim() === "") {
+            reject(process.env.ERROR_EMPTY_FIELDS);
+        }
+        else {
+            var signupData = {
+                email: email,
+                firstName: firstName,
+                inviteCode: inviteCode,
+                lastName: lastName,
+                password: password,
+                subSite: subSite,
+            };
+            var request = axiosClient_1.client.post("api/v1/users/createAccount", signupData);
+            request
+                .then(function (result) {
+                resolve(result.data.user);
+            })
+                .catch(function (error) {
+                reject(error);
+            });
+        }
+    });
+};
+/**
+ * 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>}
+ */
+var createUserAccount = function (email, firstName, lastName, password, token) {
+    return new Promise(function (resolve, reject) {
+        if (email.trim() === "" ||
+            firstName.trim() === "" ||
+            lastName.trim() === "" ||
+            password.trim() === "" ||
+            token.trim() === "") {
+            reject(process.env.ERROR_EMPTY_FIELDS);
+        }
+        else {
+            var signupData = {
+                email: email,
+                firstName: firstName,
+                lastName: lastName,
+                password: password,
+                token: token,
+            };
+            var request = axiosClient_1.client.post("api/v1/users/createUser", signupData);
+            request
+                .then(function (result) {
+                resolve(result.data.user);
+            })
+                .catch(function (error) {
+                reject(error);
+            });
+        }
+    });
+};
+/**
+ * Delete an existing API token
+ * @param {string} token Expiration date of the token
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+var deleteAPIToken = function (token, authToken) {
+    return new Promise(function (resolve, reject) {
+        var deleteTokenRequest = axiosClient_1.client.delete("api/v1/users/user/token", {
+            headers: { authorization: authToken },
+            data: {
+                token: token,
+            },
+        });
+        deleteTokenRequest
+            .then(function () {
+            resolve(token);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Delete existing users
+ * @param {string[]} userIds The ID of the users to be deleted
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+var deleteUsers = function (userIds, token) {
+    return new Promise(function (resolve, reject) {
+        var deleteTokenRequest = axiosClient_1.client.delete("api/v1/users/", {
+            headers: { authorization: token },
+            data: {
+                userIds: userIds,
+            },
+        });
+        deleteTokenRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Get all the API tokens
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+var getAPITokens = function (token) {
+    return new Promise(function (resolve, reject) {
+        var getTokensRequest = axiosClient_1.client.get("api/v1/users/getapitokens", {
+            headers: { authorization: token },
+        });
+        getTokensRequest
+            .then(function (result) {
+            resolve(result.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var getUserById = function (id, token) {
+    return new Promise(function (resolve, reject) {
+        var getUserInformationRequest = axiosClient_1.client.get("api/v1/users/user/".concat(id), {
+            headers: { authorization: token },
+        });
+        getUserInformationRequest
+            .then(function (result) {
+            if (result != null) {
+                resolve(result.data.user);
+            }
+            else {
+                reject(process.env.ERROR_INVALID_INFORMATION);
+            }
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Get user information
+ * @param {string} userId User Id
+ * @param {string} category User information category
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+var getUserInformation = function (userId, category, token) {
+    return new Promise(function (resolve, reject) {
+        var confirmationRequest = axiosClient_1.client.get("api/v1/users/user/".concat(userId || 0, "/").concat(category || "*"), {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var getUsers = function (filter, fields, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            filter: filter,
+            fields: fields,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var inviteUsers = function (invitees, groupId, teamId, authToken) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            invitees: invitees,
+            groupId: groupId,
+            teamId: teamId,
+            token: authToken,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/invite", requestData, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var login = function (email, password) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            email: email,
+            password: password,
+        };
+        var request = axiosClient_1.client.post("api/v1/auth/login", requestData);
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var loginExchangeKeys = function (code, codeVerifier, redirectUri) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            code: code,
+            codeVerifier: codeVerifier,
+            redirectUri: redirectUri,
+        };
+        var request = axiosClient_1.client.post("api/v1/auth/loginexchangekeys", requestData);
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Logout from the server. It returns a promise
+ * @param {string} token Authorization token
+ * @returns {Promise<object>}
+ */
+var logout = function (token) {
+    return new Promise(function (resolve, reject) {
+        var request = axiosClient_1.client.post("api/v1/auth/logout", {}, {
+            headers: { authorization: token },
+        });
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var refreshToken = function (refreshToken) {
+    return new Promise(function (resolve, reject) {
+        var request = axiosClient_1.client.post("api/v1/auth/refreshToken", {
+            refreshToken: refreshToken,
+        });
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Remove an existing API token
+ * @param {string} id The ID of the token to be removed
+ * @param {string} authToken Authorization token
+ * @returns {Promise<string>}
+ */
+var removeAPIToken = function (id, authToken) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            id: id,
+        };
+        var removeTokenRequest = axiosClient_1.client.post("api/v1/users/removeapitoken", requestData, {
+            headers: { authorization: authToken },
+        });
+        removeTokenRequest
+            .then(function () {
+            resolve(id);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Resend invitation emails
+ * @param {string[]} invitees List of emails of the invitees
+ * @param {string} authToken Authorization token
+ * @returns {Promise<object>}
+ */
+var resendInvitationEmails = function (invitees, authToken) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            invitees: invitees,
+            token: authToken,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/resendinvite", requestData, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var resetPassword = function (email, code, password) {
+    return new Promise(function (resolve, reject) {
+        var postData = {
+            email: email,
+            code: code,
+            password: password,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/resetpassword", postData);
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Send email confirmation code
+ * @param {string} email
+ * @param {string} token
+ * @returns {Promise<object>}
+ */
+var sendEmailConfirmationCode = function (email, token) {
+    return new Promise(function (resolve, reject) {
+        var postData = {
+            email: email,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/sendemailconfirmationcode", postData, {
+            headers: { authorization: token },
+        });
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var sendPasswordResetNotification = function (email) {
+    return new Promise(function (resolve, reject) {
+        var postData = {
+            email: email,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/sendpasswordresetnotification", postData);
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var setUserInformation = function (userId, category, data, token) {
+    return new Promise(function (resolve, reject) {
+        var _a;
+        var requestData = {
+            data: category ? (_a = {}, _a[category] = data, _a) : data,
+            userId: userId,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/user", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var updateUserEmail = function (email, verificationCode, password, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            email: email,
+            verificationCode: verificationCode,
+            password: password,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/updateemail", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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>}
+ */
+var updateUserGroups = function (userId, groups, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            userId: userId,
+            groups: groups || [],
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/user/updategroups", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function () {
+            resolve(requestData);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Update user password
+ * @param {String} password The current password
+ * @param {String} newPassword The new password
+ * @param {String} token Authorization token
+ * @returns {Promise<object>}
+ */
+var updateUserPassword = function (password, newPassword, token) {
+    return new Promise(function (resolve, reject) {
+        var requestData = {
+            password: password,
+            newPassword: newPassword,
+        };
+        var confirmationRequest = axiosClient_1.client.post("api/v1/users/updatepassword", requestData, {
+            headers: { authorization: token },
+        });
+        confirmationRequest
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+/**
+ * Validate reset password code. It returns a promise
+ * @param {String} email User's email address
+ * @param {String} code Provided reset code
+ * @returns {Promise<object>}
+ */
+var validateResetPasswordCode = function (email, code) {
+    return new Promise(function (resolve, reject) {
+        var postData = {
+            email: email,
+            code: code,
+        };
+        var request = axiosClient_1.client.post("api/v1/users/validateresetpasswordcode", postData);
+        request
+            .then(function (response) {
+            resolve(response.data);
+        })
+            .catch(function (error) {
+            reject(error);
+        });
+    });
+};
+exports.default = {
+    addAPIToken: addAPIToken,
+    confirmEmailAddress: confirmEmailAddress,
+    confirmPhone: confirmPhone,
+    confirmPhoneGenerateCode: confirmPhoneGenerateCode,
+    createAccount: createAccount,
+    createUserAccount: createUserAccount,
+    deleteAPIToken: deleteAPIToken,
+    deleteUsers: deleteUsers,
+    getAPITokens: getAPITokens,
+    getUserById: getUserById,
+    getUserInformation: getUserInformation,
+    getUsers: getUsers,
+    inviteUsers: inviteUsers,
+    login: login,
+    loginExchangeKeys: loginExchangeKeys,
+    logout: logout,
+    refreshToken: refreshToken,
+    removeAPIToken: removeAPIToken,
+    resendInvitationEmails: resendInvitationEmails,
+    resetPassword: resetPassword,
+    sendEmailConfirmationCode: sendEmailConfirmationCode,
+    sendPasswordResetNotification: sendPasswordResetNotification,
+    setUserInformation: setUserInformation,
+    updateUserEmail: updateUserEmail,
+    updateUserGroups: updateUserGroups,
+    updateUserPassword: updateUserPassword,
+    validateResetPasswordCode: validateResetPasswordCode,
+};
+//# sourceMappingURL=users.js.map